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

Implement intuitive doc release process synced with app release #111

Open
mok0230 opened this issue Apr 15, 2022 · 0 comments
Open

Implement intuitive doc release process synced with app release #111

mok0230 opened this issue Apr 15, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@mok0230
Copy link
Contributor

mok0230 commented Apr 15, 2022

Currently, we release on every push to the main branch: https://github.com/OpenZeppelin/docs.openzeppelin.com/blob/ded24596d5b6ac3ae618e96d518906a177dc9f95/playbook.yml#L62

Since many documentation PRs pertain to new features/changes in the main Defender app or defender-client packages, this produces somewhat of a clunky process where we need to merge multiple docs PRs only after the app is released and can result in accidental releases (or non-releases).

Many of the other docs.openzeppelin.com feeder repos release based on a different branch than main such a v-* (pushed when a new version is released). We should do something similar in Defender. Ideally we would add minimal requirements to the existing release process.

@mok0230 mok0230 added the enhancement New feature or request label Apr 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant