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.

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

Define what has to be done on a release #517

Closed
mliebelt opened this issue Mar 24, 2024 · 1 comment
Closed

Define what has to be done on a release #517

mliebelt opened this issue Mar 24, 2024 · 1 comment
Assignees

Comments

@mliebelt
Copy link
Owner

I need a checklist what has to be done on each release before the release is published to npm. May be it can be completely automated, but first I have to have a complete checklist that allows me not to forget anything on the way to a new build.

Acceptance Criteria

  • It is defined how the documentation is done. ✔️ I think that the wiki is most appropriate, because it will be used only in the context of Github. If later the project would be moved to somewhere else, that has to be saved as markdown then (which is easy). The wiki supports things like automatic table of contents, including the navigation.
  • The documentation exists and can be accessed by anyone. It has to be public.
  • When documenting the steps, I evaluate if those could be improved, and document that by additional issues.
  • The documentation has to be good enough to follow it by anyone knowledgeable to get a new release.
  • It has to be demonstrated by doing a new release, and taking protocol what was done.
@mliebelt mliebelt self-assigned this Mar 24, 2024
@mliebelt
Copy link
Owner Author

I have documented it now in the wiki, and will use that documentation with the next release.

The following should be enhanced in having more details: examples (how to improve them, how to test them); docs (there are some details that are not obvious); npm publication (when to update which part of the configuration in package.json)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

1 participant