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

ci: Automatically update GitHub Actions #497

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Oct 7, 2022

@coveralls
Copy link

coveralls commented Oct 7, 2022

Coverage Status

coverage: 99.822%. remained the same
when pulling d3be61f on DimitriPapadopoulos:actions
into 0d7ae7b on adrienverge:master.

@DimitriPapadopoulos
Copy link
Contributor Author

The linter issue seems unrelated. Perhaps an internal CI bug?

@adrienverge
Copy link
Owner

I try to keep this repo minimal for easier maintenance, and easier onboarding for new contributors. I'm not sure this change has a big benefit, given that yamllint only has 2 dependencies (PyYAML and pathspec). What do you think?

(I apologize if I misunderstood the purpose of this pull request, if this is the case could you explain the goal of it in the commit message?)

@DimitriPapadopoulos
Copy link
Contributor Author

DimitriPapadopoulos commented Oct 7, 2022

It just updates GitHub actions, not Python dependencies. Like #493, but it automates the creation of the merge request.

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
Copy link
Contributor

Choose a reason for hiding this comment

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

None of the strings in this YAML document need to be quoted 🙂

Copy link
Contributor Author

@DimitriPapadopoulos DimitriPapadopoulos Oct 7, 2022

Choose a reason for hiding this comment

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

I know, but they are always quoted in the reference documentation Configuration options for the dependabot.yml file, as well as other occurrences of .github/dependabot.yml.

I choose to stick to what is done elsewhere, rather than minimising the YAML file contents.

@adrienverge
Copy link
Owner

I don't see this PR-opening automation as something very useful nor as a time-saver. So unless I miss a big benefit (in which case it should go in the commit message), I'd prefer staying without it and keep the codebase minimal. What do you think?

(By the way I try to stay alert about security updates for PyYAML and Pathspec!)

@DimitriPapadopoulos
Copy link
Contributor Author

Automation in this case should not be seen as a timer-saver, but as a reminder. You will be notified (by an automated pull request) when new versions of GitHub Actions are available.

@DimitriPapadopoulos
Copy link
Contributor Author

@adrienverge
Copy link
Owner

I took time to read the documentation (especially the one you just posted https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot), and frankly I don't see the need for such a change (for the above reasons). If you're OK I'd rather keep the codebase minimal and straightforward to dive into.

@DimitriPapadopoulos
Copy link
Contributor Author

DimitriPapadopoulos commented Oct 14, 2022

I see many projects hosted in GitHub use Dependabot to automatically notify of updates of dependencies. I guess they are happy with the functionality. The downside might be how complex the CI environment itself is getting – sometimes more intricate than the code itself. However, Dependabot itself is pretty simple. I would recommend adding Dependabot, but certainly can understand that you would like to avoid it in a project with few dependencies.

@DimitriPapadopoulos
Copy link
Contributor Author

For what it's worth, this PR would tick a box in the issues reported by the Repo-Review of Scientific Python:

  • GH200: Maintained by Dependabot
    All projects should have a .github/dependabot.yml file to support at least GitHub Actions regular updates. Something like this:
    version: 2
    updates:
    # Maintain dependencies for GitHub Actions
    - package-ecosystem: "github-actions"
      directory: "/"
      schedule:
        interval: "weekly"

@adrienverge
Copy link
Owner

OK, I note that Scientific Python encourages this.

In my opinion there is no urge to keep GitHub Action files always up-to-date, and I prefer keeping this repo as simple as possible.

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

Successfully merging this pull request may close these issues.

4 participants