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

build: add authors.yml #35831

Merged
merged 1 commit into from
Aug 24, 2021
Merged

build: add authors.yml #35831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/authors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: "authors update"
Copy link
Contributor

@Mesteery Mesteery Jul 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
name: "authors update"
name: authors update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I disagree with this, since it's following a similar pattern to https://github.com/nodejs/node/actions/workflows/license-builder.yml which uses <name> update.

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay! But maybe the (useless) quotes could be removed?

on:
workflow_dispatch:
silverwind marked this conversation as resolved.
Show resolved Hide resolved

jobs:
authors_update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: '0' # this is required to actually get all the authors
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
fetch-depth: '0' # this is required to actually get all the authors
fetch-depth: 0 # this is required to actually get all the authors

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think this is a nit worth retesting the script's functionality for. It works as is, and I'd prefer not to rock the boat with changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

There is no need to retest, unless you have a doubt, in which case I think a simple YAML validator is sufficient. Otherwise, removing unnecessary quotes could make the workflow a bit more readable. Personally, I don't see any problem with that.

- run: "tools/update-authors.js" # run the AUTHORS tool
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- run: "tools/update-authors.js" # run the AUTHORS tool
- run: tools/update-authors.js # run the AUTHORS tool

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See previous comment (#35831 (comment))

- uses: gr2m/create-or-update-pull-request-action@v1 # create a PR or update the Action's existing PR
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
title: "meta: update AUTHORS"
body: "If this PR exists, there's presumably new additions to the AUTHORS file. This is an automatically generated PR by the `authors.yml` GitHub Action, which runs `tools/update-authors.js` and submits a new PR or updates an existing PR.\n\nPlease note that there might be duplicate entries. If there are, please remove them and add the duplicate emails to .mailmap directly to this PR."
Copy link
Contributor

@Mesteery Mesteery Jul 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
body: "If this PR exists, there's presumably new additions to the AUTHORS file. This is an automatically generated PR by the `authors.yml` GitHub Action, which runs `tools/update-authors.js` and submits a new PR or updates an existing PR.\n\nPlease note that there might be duplicate entries. If there are, please remove them and add the duplicate emails to .mailmap directly to this PR."
body: >
If this PR exists, there's presumably new additions to the AUTHORS file.
This is an automatically generated PR by the `authors.yml` GitHub Action,
which runs `tools/update-authors.js` and submits a new PR or updates an existing PR.
Please note that there might be duplicate entries. If there are, please remove them
and add the duplicate emails to .mailmap directly to this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See previous comment (#35831 (comment))

branch: "actions/authors-update" # custom branch *just* for this Action.
commit-message: "meta: update AUTHORS"
labels: meta