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

Update README.md contributor and release docs #237

Merged
merged 14 commits into from
Mar 26, 2024

Conversation

YesCT
Copy link
Contributor

@YesCT YesCT commented Jul 27, 2023

Ready for review/merge!

Todo:

  • verify correct information
  • identify missing information
  • refine wording
  • run TOC generation

@github-actions github-actions bot temporarily deployed to pantheon-pr-237 July 27, 2023 21:08 Destroyed
@github-actions github-actions bot temporarily deployed to pantheon-pr-237 August 7, 2023 13:47 Destroyed
README.md Outdated Show resolved Hide resolved
Co-authored-by: Andrew Berry <[email protected]>
@github-actions github-actions bot temporarily deployed to pantheon-pr-237 August 7, 2023 20:33 Destroyed
@deviantintegral deviantintegral added the documentation Improvements or additions to documentation label Feb 19, 2024
@deviantintegral
Copy link
Member

I've marked this as high as getting docs for the release process will eventually let us get to a scheduled release regardless of PTO or other time.

@YesCT
Copy link
Contributor Author

YesCT commented Feb 20, 2024

I thought drainpipe-dev was supposed to have a release for every drainpipe release.

https://github.com/Lullabot/drainpipe

3.4.1

Screenshot 2024-02-20 at 9 50 30 AM

https://github.com/Lullabot/drainpipe-dev

3.40

Screenshot 2024-02-20 at 9 50 35 AM

DOES drainpipe-dev and drainpipe always need to be released together with matching versions?? Did something change? Am I mis-remembering? cc @beto-aveiga @justafish

@davereid
Copy link
Member

davereid commented Mar 7, 2024

DOES drainpipe-dev and drainpipe always need to be released together with matching versions?? Did something change? Am I mis-remembering?

Yes I believe this is the case, they should always be released together with the same version. The most recent release now matches for both due to a technical issue that failed creating the release due to an expired access token. I can add some notes I took during last week's release process.

Resolved conflict by keeping both .gitignore additions, and picking one TOC. Will regenerate TOC.
npm install -g doctoc; doctoc README.md
@YesCT
Copy link
Contributor Author

YesCT commented Mar 12, 2024

@davereid I resolved the conflicts and updated the TOC.

Did you want to ...

add some notes I took during last week's release process.
before this is merged, or as a follow-up?

@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 12, 2024 20:40 Destroyed
README.md Outdated Show resolved Hide resolved
@davereid
Copy link
Member

@YesCT I added my release process notes and solved the Git conflicts.

@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 14, 2024 15:35 Destroyed
@YesCT
Copy link
Contributor Author

YesCT commented Mar 14, 2024

Thank you! sorry I left the conflict partially in still.

Copy link
Contributor Author

@YesCT YesCT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me! (I can't approve it, since I was the original author of the PR.)

@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 21, 2024 15:54 Destroyed
README.md Outdated

These are guidelines for conducting peer reviews on automated dependency update pull requests created by Renovate.

#### Overview
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need an overview section here? Could it not just be a part of this section above with only one sentence?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @mrdavidburns just trying to figure out the best way to merge this new section with the work that was merged in #411

@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 21, 2024 20:59 Destroyed
@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 21, 2024 21:56 Destroyed
@github-actions github-actions bot temporarily deployed to pantheon-pr-237 March 25, 2024 19:17 Destroyed
@davereid davereid merged commit 1cd4e04 into main Mar 26, 2024
35 checks passed
@davereid davereid deleted the NOTICKET--readme-contributor-release-docs branch March 26, 2024 14:33
Comment on lines +17 to +22
################
# Editors / OS #
################
.idea
.DS_Store
.vscode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@YesCT you might be interested in https://github.com/github/gitignore/tree/main?tab=readme-ov-file. It's generally recommended to put these in your global .gitignore so it automatically applies to all projects.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do. And I'll pass on that feedback to our other projects where we add this.

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

Successfully merging this pull request may close these issues.

3 participants