Skip to content

Commit 6e38c60

Browse files
authored
Update README.dev.md
1 parent 8d575f6 commit 6e38c60

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.dev.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,19 @@ npm run test:unit:ui
8787

8888
## Making a release
8989

90-
1. Review CITATION.cff and update it if needed
90+
This section describes how to make a release in 2 parts:
91+
92+
1. preparation
93+
1. making a release on GitHub
94+
95+
### (1/2) Preparation
96+
97+
1. Verify that the information in `CITATION.cff` is correct
98+
1. By running `npm run lint` make sure the linter does not complain
99+
1. Run the unit tests with `npm run test:unit:ci`
100+
1. Make sure that github.io page is up to date
101+
1. Check whether the [Publish](https://github.com/citation-file-format/cffinit/actions/workflows/publish.yml) workflow worked recently and it was successful
102+
103+
### (2/2) GitHub
104+
105+
Make a [release on GitHub](https://github.com/citation-file-format/cffinit/releases/new).

0 commit comments

Comments
 (0)