Skip to content

ci: match Rustls style, add cargo-semver-checks, dependabot#118

Merged
cpu merged 9 commits intorustls:mainfrom
cpu:cpu-match-workflows
Jul 14, 2023
Merged

ci: match Rustls style, add cargo-semver-checks, dependabot#118
cpu merged 9 commits intorustls:mainfrom
cpu:cpu-match-workflows

Conversation

@cpu
Copy link
Member

@cpu cpu commented Jul 11, 2023

Description

In #115 it was pointed out that the webpki CI wasn't very consistent with the Rustls repo. In particular the whitespace style differed, and steps weren't being annotated with names.

This branch does a quick standardization pass, and also adds a new cargo-semver-check step, tightens up the cargo doc step to forbid warnings, adds a cron schedule, and adds a dependabot config.

Probably easiest to review commit-by-commit.

@cpu cpu self-assigned this Jul 11, 2023
@cpu
Copy link
Member Author

cpu commented Jul 11, 2023

clippy Expected — Waiting for status to be reported

I'll need to fix up the branch protection rules - the name changes have thrown them off.

cpu added 9 commits July 14, 2023 08:38
This commit moves around some whitespace to match the convention the
`rustls/rustls` CI repo uses.
This commit reorders the `on` triggers to match the rustls repo, and ads
a `cron` scheduled run to ensure we catch bitrot early even if the repo
isn't seeing active development.
In our other repos we tend to use the checkout action step first, and
then the other steps.

We can also avoid the YAML multi-line scalar stuff for simple lines.
In the rustls repo we tend to 'name' tasks. This commit applies the same
convention/choice of names here.
* Add a cron schedule.
* Consistent whitespace.
This commit adds a dependabot config matching the main rustls repo.
This commit updates the `build.yml` GitHub actions workflow to
additionally include a step that checks semver compatibility w/
cargo-semver-checks[0].

Notably this check passing is necessary but not sufficient for knowing
that we're maintaining semver: if this tool produces a finding we know
we aren't matching semver, but if it doesn't, we may still be breaking
semver in a way the tool can't detect.

[0]: https://github.com/obi1kenobi/cargo-semver-checks
@cpu cpu force-pushed the cpu-match-workflows branch from 0b254f3 to a83b5eb Compare July 14, 2023 12:42
@codecov
Copy link

codecov bot commented Jul 14, 2023

Codecov Report

Merging #118 (a83b5eb) into main (b23e6de) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #118   +/-   ##
=======================================
  Coverage   95.69%   95.69%           
=======================================
  Files          15       15           
  Lines        3346     3346           
=======================================
  Hits         3202     3202           
  Misses        144      144           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@cpu
Copy link
Member Author

cpu commented Jul 14, 2023

cpu force-pushed the cpu-match-workflows branch from 0b254f3 to a83b5eb

Rebased.

When CI completes I'll administratively merge and then fix the branch protection rules to match the new task names.

@cpu cpu merged commit c8856c8 into rustls:main Jul 14, 2023
@cpu cpu deleted the cpu-match-workflows branch July 14, 2023 12:47
@cpu
Copy link
Member Author

cpu commented Jul 14, 2023

Branch protection rules updated.

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.

2 participants