Commit graph

113 commits

Author SHA1 Message Date
Magnus Markling
b4150892af
add npm login section to CONTRIBUTING.md (#89) 2024-07-27 22:42:47 -04:00
Magnus Markling
afd6f0d40c
Upgrade dependencies (#87)
* upgrade glob

* upgrade @actions/github

* upgrade other dependencies

* regen dist files
2024-07-26 10:08:05 -04:00
Predrag Gruevski
1e324fdfad
Future c-s-c versions will require Rust 1.77+ so test that min version. (#86) 2024-07-24 23:14:42 +00:00
Magnus Markling
7272cc2caa
add CONTRIBUTING.md (#84) 2024-07-24 22:20:56 +00:00
Magnus Markling
233c33101f
Fix npm vulnerabilities (#85)
* run npm audit fix

* regenerate dist files
2024-07-24 17:59:45 -04:00
Magnus Markling
ca26a44cfb
Add target input (#82)
* add rust-target as input

Signed-off-by: Magnus Markling <magnus@markling.com>

* update readme

Signed-off-by: Magnus Markling <magnus@markling.com>

* fix spelling error

Signed-off-by: Magnus Markling <magnus@markling.com>

* Update README.md

Signed-off-by: Magnus Markling <magnus@markling.com>
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* update example

Signed-off-by: Magnus Markling <magnus@markling.com>

* use actions-rust-lang instead of dtolnay

Signed-off-by: Magnus Markling <magnus@markling.com>

* use stable instead of stable 2 months

Signed-off-by: Magnus Markling <magnus@markling.com>

* Update README.md

Signed-off-by: Magnus Markling <magnus@markling.com>
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* add missing input def

Signed-off-by: Magnus Markling <magnus@markling.com>

* rebuild index.js

Signed-off-by: Magnus Markling <magnus@markling.com>

* update action.yml

Signed-off-by: Magnus Markling <magnus@markling.com>

---------

Signed-off-by: Magnus Markling <magnus@markling.com>
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2024-07-14 19:29:10 +00:00
Predrag Gruevski
37af5d4093
Nightly support is best-effort. Its CI steps are advisory, not required. (#83)
* Nightly support is best-effort. Its CI steps are advisory, not required.

* Avoid use of nightly Rust in `test-inputs.yml` tests.
2024-07-14 19:23:01 +00:00
Predrag Gruevski
70850f22aa
Add FUNDING.yml to the action. (#81) 2024-07-02 17:22:49 +00:00
Magnus Markling
e0ec8d834f
Use checkout v4 (#80)
* update to actions/checkout@v4 in workflows

* update to actions/checkout@v4 in examples
2024-07-02 12:50:12 -04:00
Magnus Markling
bb0df35464
Upgrade glob to 10.4.2 (#78)
* upgrade glob to 10.4.2

* rebuild dist files
2024-07-02 15:46:54 +00:00
Magnus Markling
3e1d1b2a1f
Clarify caching inputs (#77) 2024-07-02 15:44:14 +00:00
Predrag Gruevski
300d7d49b9
Update cache keys in test-inputs.yml (#79)
It's always caching. Or DNS. This time it was caching.

A while back, we changed the default cache key prefix from empty-string to `semver` so that our cache key names don't start with a dash, since users found that confusing.

We should have updated these tests accordingly at the time, but we did not. So how did the PR with the change pass?

It used the caches from older runs of the same job which used the old names. When those caches expired and were GC'd by GitHub, the jobs started failing.

This is what broke CI for #77. This PR will fix it.
2024-07-02 14:47:48 +00:00
Predrag Gruevski
c7306483f6
Avoid leading dash in cache key. (#67)
Fixes #66.
2024-03-19 19:33:21 +00:00
Predrag Gruevski
17d9392a8c
Update dependency and Node versions. (#68)
* Update dependency and Node versions.

* Re-lock.
2024-03-19 18:32:54 +00:00
dependabot[bot]
c451059d78
Bump actions/checkout from 3 to 4 (#73)
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-19 14:30:33 -04:00
dependabot[bot]
e7dd74ede1
Bump actions/cache from 3 to 4 (#72)
Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4.
- [Release notes](https://github.com/actions/cache/releases)
- [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
- [Commits](https://github.com/actions/cache/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/cache
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-19 17:38:41 +00:00
dependabot[bot]
5bf52b80b3
Bump actions/setup-node from 3 to 4 (#74)
Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](https://github.com/actions/setup-node/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-19 17:35:22 +00:00
dependabot[bot]
894af04ddc
Bump actions/upload-artifact from 3 to 4 (#71)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-19 17:30:32 +00:00
Predrag Gruevski
829f70f3f3
Add dependabot to keep GitHub Actions updated. (#70) 2024-03-19 17:24:11 +00:00
Predrag Gruevski
9a25a25ffa
Update CI to use Rust 1.74, the new MSRV. (#69) 2024-03-19 17:12:20 +00:00
Predrag Gruevski
48f4ef7da6
Update action to use Node 20 (#63)
Resolves #62.
2024-01-25 21:48:51 +00:00
Predrag Gruevski
6fec02f09a
Fix name of --features option in README (#57)
Resolves #56.
2023-11-09 23:59:55 +00:00
Predrag Gruevski
b3bcbfd5ac
Minimum Rust known to avoid all rustdoc JSON bugs is 1.73 (#60) 2023-11-09 23:57:34 +00:00
Predrag Gruevski
e275dda72e
Document the new action inputs. (#52) 2023-06-06 19:35:53 +00:00
Predrag Gruevski
050645d214
Minimum supported Rust is 1.67. (#51) 2023-06-06 15:04:58 -04:00
Predrag Gruevski
49c4f979e7
Ensure that failing tests prevent PRs from being merged. (#50) 2023-06-06 14:59:32 -04:00
Predrag Gruevski
06053f9c6c
Support specifying features to test. (#49) 2023-06-06 14:49:48 -04:00
Mieszko Grodzicki
651743decf
Change the structure of README (#46)
* Change the structure of README

* Restore removed example, consisted new lines

* Expand Basic usage section

* Apply suggestions from code review

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-05-02 15:36:00 -04:00
Mieszko Grodzicki
ca4682c48b
Use folder-hash instead of hash-files. (#45)
* Use folder-hash instead of hash-files.

* Fix indentation in jest.config.js

* awaits in separate lines
2023-04-30 15:37:33 -04:00
Mieszko Grodzicki
3dda4826a4
Polishing README (#43)
* Remove repeated cargo publish

* Headings and table of contents
2023-04-23 23:02:09 -04:00
Mieszko Grodzicki
93cab96796
Remove warning in README (#42) 2023-04-23 16:08:02 -04:00
Mieszko Grodzicki
69730c4d83
Add input release-type (#39) 2023-04-23 20:37:51 +02:00
Mieszko Grodzicki
8b981cde1a
Add input exclude, allow list in package (#40)
* Add exclude, allow lists in package

* Add test for input exclude

* Second dummy crate in test workspace

* New tests

* Fix cache key

* Forgot about flat()

* Reflect changes in docs

* New key in cache test

* Shorter job name

* Allowed to fail -> expected to fail

* Update README.md

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* Hash inputs in cache key

* Update cache test

* Update README

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-04-23 14:24:06 -04:00
Mieszko Grodzicki
7eca687541
Change '' to 'manual' for rust-toolchain input (#41)
* Change '' to 'manual' for rust-toolchain

* Default is stable, modify tests
2023-04-23 12:35:09 -04:00
Mieszko Grodzicki
670e9a45ae
Include package and manifest-path in the cache key (#38)
* New caching strategy

* Update README.md

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-04-23 10:37:17 +02:00
Mieszko Grodzicki
f2825830a8
Environmental variables (#28) (#36)
* Setting environmental variables

* Test the action also on 1.67
2023-04-17 08:45:37 -04:00
Mieszko Grodzicki
f9ffdc4a3d
Add inputs to control the Rust toolchain (#34)
* Add inputs for controlling rust toolchain

* Add tests for new inputs

* Negated ifs!

* Fix action input name

* Better description of rust-override

* New logic of choosing toolchain

* Add explaining comment.

* Add rust-toolchain.toml test
2023-04-08 10:21:06 -04:00
Mieszko Grodzicki
43d6c89249
Remove TODOs from workflows. (#35)
* Remove TODOs from workflows.

* Remove TODO in test-cache.yml
2023-04-08 10:19:56 -04:00
Mieszko Grodzicki
461983b3bb
Add test for baseline caching (#33)
* Cache test

* Baseline caching - initial work

* Add comment explaining the change of CARGO_TARGET_DIR.

* Update README.md

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* Refactor getRustcVersion and getCargoSemverChecksVersion

* Move helper functions outside RustdocCache class.

* cachePath passed in constructor

* workspaceRoot as constructor argument

* Inline getManifestDir

* Change target to semver-checks/target

* Fix missing hash-files

* Add workflow testing caching

* New line

* Add checking the updated cache

* Missing semicolon

* Bad job name in cache key

* Upload cache if its hash changes

* Test options cache-key and prefix-key

* Need to use restore-keys

* Is path a problem?

* Absolute path

* Move

* Fix restore inputs

* Verify

* Revert debug

* Rustc and semver-checks versions should not be fixed!

* debug test

* key not being a prefix

* Missing outputs

* Revert letter change in hash

* Update CI README

* TODO comments, shorter names

* Better names

* check the key

* Missing '

* Remove space

* Missing outputs

* Remove hash check

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* Remove inconsistent newlines from workflows README

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-04-07 10:54:46 -04:00
Mieszko Grodzicki
a976a2e219
Remove temporary fix for Windows machines. (#32) 2023-04-05 15:19:29 -04:00
Mieszko Grodzicki
913235ca66
Baseline rustdoc caching (#29)
* Baseline caching - initial work

* Add comment explaining the change of CARGO_TARGET_DIR.

* Update README.md

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>

* Refactor getRustcVersion and getCargoSemverChecksVersion

* Move helper functions outside RustdocCache class.

* cachePath passed in constructor

* workspaceRoot as constructor argument

* Inline getManifestDir

* Change target to semver-checks/target

* Fix missing hash-files

* Upload cache if its hash changes

* Add input prefix-key

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-04-04 09:26:44 -04:00
Mieszko Grodzicki
a609ba51bf Polish input descriptions 2023-02-28 18:59:49 -05:00
Mieszko Grodzicki
6cf50904d1 Update README.md
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-02-28 18:59:49 -05:00
Mieszko Grodzicki
3cf3a963be Document manifest-path default behaviour 2023-02-28 18:59:49 -05:00
Mieszko Grodzicki
5fbde10d11 Make ref-slice-ref required 2023-02-28 18:59:49 -05:00
Mieszko Grodzicki
1fb47cb228 Get rid of fetch-depth: 0 in test-manifest-path-with-space 2023-02-27 16:42:26 -05:00
Mieszko Grodzicki
705cfec6cc Minor fixes in inputs specifications 2023-02-27 16:42:26 -05:00
Mieszko Grodzicki
e5740164f3 Env variables in ci.yml 2023-02-27 16:42:26 -05:00
Mieszko Grodzicki
5618d5abb9 CI improvements (#17) 2023-02-27 16:42:26 -05:00
Mieszko Grodzicki
4a28a50dd4 Update README.md
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
2023-02-27 16:42:26 -05:00