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

Release pulse - issue template #394

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

GeorgianaElena
Copy link
Member

@GeorgianaElena GeorgianaElena commented Mar 25, 2021

This release reminder issue template is based on what @choldgraf implemented for the 2i2c team syncs.

It adds an issue template that:

  • contains references to z2jh:
    • latest version
    • unmerged commits
    • open
  • contains links to the unmerged commits in some z2jh dependencies.

It is opened at 00:00 (UTC I believe) on 1st day of month, every 3rd months and closed 7 days later (found this nice blog post that referenced this useful crontab app https://jasonet.co/posts/scheduled-actions/).

TODOs:

  • Create secrets.ACCESS_TOKEN needed by post_release_pulse.py
    cc @choldgraf, can we reuse secrets.GITHUB_TOKEN for this?
  • Reference the actual team-compass repo instead of my fork
  • Schedule this to run now so we can see it in action
  • Make the template's content better

This is how the issue template should look like after the placeholders are replaced with their actual values:
Filled-in-template

What do you all think? 👀

Ref: #384

@sgibson91
Copy link
Member

sgibson91 commented Mar 25, 2021

  • Create the access tokens needed by this secrets.ACCESS_TOKEN AND secrets.GITHUB_TOKEN

secrets.GITHUB_TOKEN is automatically created by GitHub Actions, no need to create it - I believe it should have enough permissions but always good to double check. Docs: https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret

@GeorgianaElena
Copy link
Member Author

Thank you @sgibson91 ❤️ I've updated the initial bullet point.

@consideRatio
Copy link
Member

consideRatio commented Mar 25, 2021

@GeorgianaElena wieee nice work on this!!! I was thinking we could have some checkboxes summarizing the steps to take perhaps.

KubeSpawner (some dependency for z2jh)

  • Release
    • A new release has been made
    • No new PRs had been merged, or a release isn't warranted for some reason
  • Z2JH pinned version updated (A PR should be automatically created for python dependencies, but not for configurable-http-proxy's image)

Finally Z2JH itself

  • Changelog
  • Tag pushed

When I think about it, this should perhaps to a large extent be the same as z2jh's RELEASE.md, right? We can always strip away everything in z2jh's RELEASE.md file except for a reference to this GitHub workflow triggered process.

@choldgraf
Copy link
Member

choldgraf commented Mar 25, 2021

I agree it's helpful to have the to-do items explicitly in these kinds of issues. I think we could also include links next to each one that would help the person in accomplishing them. E.g., - [ ] make a release (<link to instructions for this>), that kinda thing

@GeorgianaElena
Copy link
Member Author

Thank you! 🌞 I've added some checklists and links to the release instructions.

Just an idea
I noticed that the 2jh RELEASE.md encourages that the file's content is used as an issue template. This made me think that instead of creating a new issue template in team-compass we could use RELEASE.md directly.

What do you think? Do we want to keep the issue reminder in team-compass as a short summary of the release process or would it be better to have it be super specific?

@sgibson91
Copy link
Member

I think one of the benefits of having it in team-compass is that the whole team will be notified and then we can begin to work out if a pulse like this can helps us work towards synchronicity across the interdependent repos. Happy to hear counter-arguments though ✨

@choldgraf
Copy link
Member

I still think that this would be a helpful team pattern to try out. Anything preventing us from merging?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants