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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migrate to main branch #76

Merged
merged 8 commits into from Aug 23, 2021
Merged

docs: migrate to main branch #76

merged 8 commits into from Aug 23, 2021

Conversation

@dandhlee
Copy link
Contributor

@dandhlee dandhlee commented Aug 23, 2021

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #75 馃

@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run label Aug 23, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run label Aug 23, 2021
@dandhlee dandhlee marked this pull request as ready for review Aug 23, 2021
@dandhlee dandhlee requested a review from as a code owner Aug 23, 2021
owlbot.py Outdated
s.replace(
"CONTRIBUTING.rst",
"master",
"main"
)

s.replace(
"docs/conf.py",
"master",
"main"
)

s.replace(
".kokoro/*",
"master",
"main"
)

Choose a reason for hiding this comment

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

Did you have to use owlbot for this because we can't update the templates yet?

Loading

Copy link
Contributor Author

@dandhlee dandhlee Aug 23, 2021

Choose a reason for hiding this comment

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

Yes, I believe the plan is to update on the branches first, and then we'll update the templates. Once that's done we'll revert the changes on OwlBot.

Loading

Copy link
Collaborator

@busunkim96 busunkim96 Aug 23, 2021

Choose a reason for hiding this comment

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

Another suggestion is to have a flag that switches main/master in the templates so it's a one line change. Post-migration you can just make main the default.

I did something similar back when we were moving to the microgenerator.

Loading

Copy link
Contributor Author

@dandhlee dandhlee Aug 23, 2021

Choose a reason for hiding this comment

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

That sounds good @busunkim96, do you have any links for the previous PRs with those examples? Can't visualize how that'd work here :/

Loading

@dandhlee dandhlee requested a review from jimfulton Aug 23, 2021
Copy link
Contributor

@parthea parthea left a comment

Added 2 minor observations

Loading

docs/conf.py Outdated Show resolved Hide resolved
Loading
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Loading
@dandhlee dandhlee requested a review from parthea Aug 23, 2021
@dandhlee
Copy link
Contributor Author

@dandhlee dandhlee commented Aug 23, 2021

Please take a look again!

Loading

@dandhlee dandhlee merged commit 4f36a1d into main Aug 23, 2021
6 checks passed
Loading
@dandhlee dandhlee deleted the to_main branch Aug 23, 2021
@tseaver
Copy link
Contributor

@tseaver tseaver commented Aug 24, 2021

For future PRs, this should not be labeled docs:, but rather chore: -- no user-relevant change is occuring.

Loading

@parthea
Copy link
Contributor

@parthea parthea commented Aug 24, 2021

@dandhlee @nicain Please use chore: moving forward for the commit message/PR title.

Loading

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

Successfully merging this pull request may close these issues.

5 participants