Skip to content

Commit 0885c08

Browse files
authored
Update README.dev.md
1 parent 6b25fb0 commit 0885c08

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.dev.md

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

138138
### (1/2) Preparation
139139

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
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 Netlify preview website.
150150

151151
### (2/2) Making a release on GitHub
152152

153153
1. Make a [release on GitHub](https://github.com/citation-file-format/cff-initializer-javascript/releases/new).
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.
155-
3. Go to Zenodo, log in, inspect the draft release. If all looks good, click "Publish" in Zenodo's frontend.
154+
1. Check that the [Publish](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/publish.yml) workflow was triggered by making the release, and that it was successful.
155+
1. Inspect the deployed github.io website [https://citation-file-format.github.io/cff-initializer-javascript/](https://citation-file-format.github.io/cff-initializer-javascript/).
156+
1. 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.
157+
1. Go to Zenodo, log in, inspect the draft release. If all looks good, click "Publish" in Zenodo's frontend.
156158

157159
## References
158160

0 commit comments

Comments
 (0)