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

build: rename master branch to main branch [actions testing PR] #2

Closed
wants to merge 2 commits into from

Conversation

agilgur5
Copy link
Owner

@agilgur5 agilgur5 commented Nov 25, 2023

Fixes argoproj#12127 -- this is a testing PR for argoproj#12149 per argoproj#12149 (review)

Motivation

  • Prefer more inclusive language

Modifications

  • change GH Actions to use main branch in several branch checks

    • and change GH issue templates to use main branch
  • change scripts to use main branch

  • change docs to use main branch

    • also in many places we had absolute links instead of relative links
      • docs convention is to use relative links where possible
      • changing these to relative links meant that we no longer need to change the branch
      • some docs also linked to the codebase when there's a page in the docs for it; relative link to the docs where appropriate
    • change a few docs to use a permalink instead of a link to master
      • Upgrading Notes and Proposals in particular linked to a specific line in a file, which is no longer the correct line
        • fix the broken links with permalinks, since those docs are time-specific
    • change a few links to argoproj/argoproj/master to use main as well, since per Rename the master branch to the main branch argoproj/argoproj#35 that repo's branch was already renamed
    • misc docs improvements while changing these lines
      • use code backticks when referring to specific resource names, directories, etc, per k8s style guide
      • prefer 1 sentence per line where the whole file didn't need changing
      • add a few links to other docs where appropriate (e.g. when referencing environment variables)
      • improve ambiguous link text, per k8s style guide
      • etc
  • change UI references (that linked to examples) to use the main branch

    • and change one UI reference to link to the rendered docs website instead of the docs on main

Verification

  1. make docs and make codegen passes

  2. Using this very PR in my own fork for testing purposes.

    • EDIT: All actions ran correctly as intended. There's just one lint error to fix (which will actually be fixed in a different way once I rebase to include the linter refactor/upgrade)

Notes to Reviewers

We should rename the branch on GH before this is merged.

  • This has been done already for this testing PR

The branch rename functionality in GH will ensure that everything is redirected to the new branch name as well.

- change GH Actions to use `main` branch in several branch checks
  - and change GH issue templates to use `main` branch
- change scripts to use `main` branch

- change docs to use `main` branch
  - also in many places we had absolute links instead of relative links
    - docs convention is to use relative links where possible
    - changing these to relative links meant that we no longer need to change the branch
    - some docs also linked to the codebase when there's a page in the docs for it; relative link to the docs where appropriate
  - change a few docs to use a permalink instead of a link to `master`
    - Upgrading Notes and Proposals in particular linked to a specific line in a file, which is no longer the correct line
      - fix the broken links with permalinks, since those docs are time-specific
  - misc docs improvements while changing these lines
    - use code backticks when referring to specific resource names, directories, etc, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#code-style-inline-code)
    - prefer 1 sentence per line where the whole file didn't need changing
    - add a few links to other docs where appropriate (e.g. when referencing environment variables)
    - etc

- change a UI references (that linked to examples) to use the `main` branch
  - and change one UI reference to link to the rendered docs website instead of the docs on `main`

Signed-off-by: Anton Gilgur <[email protected]>
- linked to a `blame` instead of the code view on GH accidentally; fixed

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5
Copy link
Owner Author

agilgur5 commented Nov 29, 2023

All actions ran correctly as intended!

There's just one lint error to fix (which will actually be fixed in a different way once I rebase to include the linter refactor/upgrade).

Closing this testing PR out now -- see upstream argoproj#12149

@agilgur5 agilgur5 closed this Nov 29, 2023
Repository owner locked as resolved and limited conversation to collaborators Jul 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename master branch to main branch
1 participant