Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add release process description to README. #37

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add release process description to README. #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,22 @@ $ npm i
$ npm run build # build and watch index.js changes
$ npm run start # serve this directory
```

## Creating a Release

NOTE: This release process is not ideal and is planned to be changed/imporved in future.

To create a new release:

1. Clear out `node_modules/` and `dist/`
2. `git pull origin main`
3. `git checkout -b VERSION` (where `VERSION` is something like `3.3.2`)
4. `npm i`
5. `npm run build`
6. Test by running `npm run start` and ensure `index.html` loads without errors.
7. `git add dist/main.js && git commit -a`
6. `git tag VERSION`
7. `git push --tags`

**DO NOT merge the branch down to main.** All tagged releases are
"headless" because they contain massive 7MB files.