Skip to content

Commit b6c7869

Browse files
committed
updated release notes
1 parent 514dbff commit b6c7869

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.dev.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,21 +137,22 @@ This section describes how to make a release in 2 parts:
137137

138138
### (1/2) Preparation
139139

140-
1. Verify that the information in `CITATION.cff` is correct
141-
2. Generate an updated version of `.zenodo.json` if needed using `cffconvert`
142-
3. Make sure the version field in `package.json` and `package-lock.json` are correct
143-
4. Update the version in the [landing page footer](src/components/LayoutLanding.vue).
144-
5. Update the version in the [app footer](src/components/Footer.vue).
145-
6. By running `npm run lint` make sure the linter does not complain
146-
7. Run the unit tests with `npm run test:unit:ci`
147-
8. Make sure that github.io page is up to date
148-
149-
### (2/2) GitHub
140+
1. Update the information in `CITATION.cff`
141+
1. Generate an updated version of `.zenodo.json` if needed using `cffconvert`
142+
1. Update the version field in `package.json` and `package-lock.json`
143+
1. Update the version in the [landing page footer](src/components/LayoutLanding.vue)
144+
1. Update the version in the [app footer](src/components/Footer.vue)
145+
1. Run `npm run lint` and make sure the linter does not complain
146+
1. Run the unit tests with `npm run test:unit:ci`
147+
1. Push any changes to GitHub, then review and merge to the default branch `main`
148+
1. Check that the [Publish](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/publish.yml) workflow was triggered by merging to `main` and that it was successful
149+
1. Inspect the deployed website
150+
151+
### (2/2) Making a release on GitHub
150152

151153
1. Make a [release on GitHub](https://github.com/citation-file-format/cff-initializer-javascript/releases/new).
152-
2. Check whether the [zenodraft](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/zenodraft.yml) workflow was triggered correctly by the GitHub release.
154+
2. Check whether the [zenodraft](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/zenodraft.yml) workflow was triggered correctly by making the GitHub release.
153155
3. Go to Zenodo, log in, inspect the draft release. If all looks good, click "Publish" in Zenodo's frontend.
154-
4. Check that the [Publish](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/publish.yml) workflow ran for the new tag and it was successful.
155156

156157
## References
157158

0 commit comments

Comments
 (0)