Open
Description
This template guides us through the steps of creating a new release, based on conversation and testing in #1692.
Discuss with @publiclab/is-maintainers if anything is ambiguous!
Also see:
- open an issue using the "release" template with this checklist with title
Checklist and coordination for v0.0.0 major/minor/patch release
(see semantic versioning) - create a release project from this template. You can copy a project from its menu.
- compile release notes below from corresponding release project.
- open a pull request with updated version numbers
- update version number in
package.json
(ex Bump to v3.6.0 for new npm release #1695) - update version number in
examples/sw.js
(ex Bump lockfile and sw.js versions for v3.6.0 #1734) - run
npm install
to updatepackage-lock.json
(from recent node version - 16 at time of writing, in GitPod should work) - check in
package-lock.json
- update version number in
- finalize and merge to
main
branch (freeze merges tomain
branch until next step)
Now, move to stable
branch:
- force push from
main
tostable
- then in
stable
branch, compile/dist/
files withgrunt build
- add
/dist/
files withgit add -f /dist/*
and commit them tostable
branch - publish
stable
branch tonpm
withnpm publish
(logging in first as necessary)
Draft a release:
- create a release on GitHub and use features description + release notes from below
- tag version number branch (i.e.
v0.0.0
) based onstable
or choosestable
- publish to live Github pages demo (with bash script from
/scripts/update-demo
) (from within GitPod works well) - move anything necessary to next release project, i.e. https://github.com/publiclab/image-sequencer/projects/[insert project number]
- close this issue!
Noting we're now in this process in #1751 for v3.7.0
.
Release notes
Compile and edit release notes below, to be copied into the release description.
Added
Fixed
(almost ready):
- Fix generateOutput called multiple times #1564 (high priority)
- Fix error in replaceImage function #1625 (high priority, needs test)
- Fixes error on
|
character in CLI #1634