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.

Sign up for GitHub

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

Jump to bottom

[Website] Remove mentions of master branch from Apache Arrow website content #20161

Closed
Tracked by #31142
asfimport opened this issue Mar 21, 2022 · 4 comments · Fixed by apache/arrow-site#324
Closed
Tracked by #31142

[Website] Remove mentions of master branch from Apache Arrow website content #20161

asfimport opened this issue Mar 21, 2022 · 4 comments · Fixed by apache/arrow-site#324
Assignees
@kevingurney
Labels
Component: Website good-first-issue Type: task

Comments

@asfimport
Copy link
Collaborator

This is a follow up task to ARROW-15694 and ARROW-15988.

We need to update the actual content of the Apache Arrow website to no longer refer to the "master" branch. This includes updating links, text snippets, and the README.md for {}arrow-site{}. There may also be other files that need to be updated, as well.

Reporter: Kevin Gurney / @kevingurney

Note: This issue was originally created as ARROW-15991. Please see the migration documentation for further details.
@asfimport
Copy link
Collaborator Author

Todd Farmer / @toddfarmer:
This issue was last updated over 90 days ago, which may be an indication it is no longer being actively worked. To better reflect the current state, the issue is being unassigned. Please feel free to re-take assignment of the issue if it is being actively worked, or if you plan to start that work soon.

@asfimport asfimport mentioned this issue Jan 11, 2023
Closed
14 tasks
@kevingurney
Copy link
Member

I've done some preliminary investigation of this issue.

It seems like the uses of "master" in apache/arrow-site can be categorized as follows:

  1. Uses in the _release directory. It's unclear whether it makes sense to change these uses since these are referring to a past state of the repository.
  2. Uses in the _posts directory. Similar to 1., it's not clear whether it makes sense to change these uses.
  3. Uses in index.html. All these uses appear to be links referring to files/directories in the apache/arrow directory. Therefore, we should be able to change this to main now that the default branch of the apache/arrow repo has been renamed to main.
  4. Uses in overview.md. Same as 3.
  5. Uses in _includes/header.html. Same as 3.
  6. Uses in README.md. It seems like we could change the use of "master" in the phrase "On commits to the master branch of apache/arrow-site" to "On commits to the default branch of apache/arrow-site". Alternatively, we could change "master" to "main" after the default branch has been renamed to "main" for the apache/arrow-site repo.
  7. Uses in install.md. This is referring to https://github.com/msys2/MINGW-packages/tree/master/mingw-w64-arrow. We could change this to https://github.com/msys2/MINGW-packages/tree/HEAD/mingw-w64-arrow.
  8. Uses in powered_by.md. The only use is in https://github.com/apache/arrow-site/edit/master/powered_by.md. It might be OK to change this to https://github.com/apache/arrow-site/edit/HEAD/powered_by.md. Although, it is slightly unclear to me whether referring to HEAD here is actually equivalent. Otherwise, changing this to "main" is dependent on the apache/arrow-site default branch being renamed to "main" first.
  9. Uses in community.md. The only use is in the phrase "commits@ for commits to the apache/arrow and apache/arrow-site repositories (typically to master only)...". Changing this use depends on the default branch of apache/arrow-site being renamed to "main".
  10. Uses in .github/workflows/deploy.yml. Removing these uses depends on the default branch of apache/arrow-site being renamed to main. See [Website] Remove support for triggering GitHub Actions apache/arrow-site website deployment workflow when pushing to master #31412, which is being used to track this usage.

Since removing several of the uses of "master" in the Apache Arrow website are dependent on the default branch name of the apache/arrow-site repo being renamed to "main", it might make sense to consider this issue "non-blocking" for the time being and focus on getting the default branch renamed to "main" for apache/arrow-site. Once the rename is complete, I can open a PR to remove the remaining uses of "master".

Alternatively, I am also more than happy to create a PR now to address the uses above which aren't dependent on the default branch of apache/arrow-site being renamed to main and to follow up with another PR to remove the remaining uses after the default branch rename is complete. I can follow whichever approach the community feels makes the most sense.

@kevingurney
Copy link
Member

take

This was referenced Feb 28, 2023
Merged
Merged
@kevingurney
Copy link
Member

I've opened PR apache/arrow-site#324 to address this issue.

kou pushed a commit to apache/arrow-site that referenced this issue Mar 1, 2023
@kevingurney
GH-31412: [Website] Remove support for triggering GitHub Actions apac…
26c92c9 
…he/arrow-site website deployment workflow when pushing to master (#323)

# Overview

As part of apache/arrow#31142 and in response to the [recent rename of
the `apache/arrow-site` repository default branch to
`main`](https://issues.apache.org/jira/browse/INFRA-24242), this pull
request removes support for triggering the website deployment workflow
(`.github/workflows/deploy.yml`) on pushes to a branch with the name
"master".

# Qualification

To qualify these changes, I verified that:

1. Pushing these changes to the `main` branch of `mathworks/arrow-site`
[triggered the `deploy.yml` workflow as
expected](https://github.com/mathworks/arrow-site/actions/runs/4296490412/jobs/7488276762).
2. The workflow step "Configure for GitHub Pages on push to main or
master branch" has been renamed to "Configure for GitHub Pages on push
to main branch"
3. The `deploy.yml` is no longer being triggered when commits are pushed
to a branch named "master".

# Future Directions

1. I will follow up with a separate PR to address apache/arrow#20161

# Notes

**Note**: The [CI failures in the Build
step](https://github.com/mathworks/arrow-site/actions/runs/4296490412/jobs/7488276762)
are unrelated to this change. This is a result of apache/arrow#34379,
which is being addressed separately.

Closes apache/arrow#31412.
kou pushed a commit to apache/arrow-site that referenced this issue Mar 1, 2023
@kevingurney
GH-20161: [Website] Remove mentions of master branch from Apache Arro…
a63941c 
…w website content (#324)

# Overview

As part of apache/arrow#31142 and in response to the [recent rename of
the `apache/arrow-site` repository default branch to
`main`](https://issues.apache.org/jira/browse/INFRA-24242), this pull
request removes mentions of the "master" branch from the Apache Arrow
website content.

# Qualification

To qualify these changes, I:

1. Performed a local build and preview of the website using `bundle exec
rake` and manually verified that all the links are still working.

# Future Directions

1. There are still some remaining tasks listed in apache/arrow#31142
related to the renaming of the default branch of the `apache/arrow` repo
(and related repositories) to `main`.

# Notes

**Note**: I left the mentions of "master" in the `_release` and `_posts`
directory unmodified. As described in
apache/arrow#20161 (comment),
it's unclear whether it makes sense to change these uses since these are
referring to a past state of the repository. If the community would
prefer that we also removes mentions of "master" from these directories,
I would be more than happy to do so.

Closes apache/arrow#20161.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kevingurney kevingurney

Labels
Component: Website good-first-issue Type: task
Projects
None yet
Milestone
No milestone
3 participants
@kevingurney @assignUser @asfimport