Commit Graph

91 Commits

Author SHA1 Message Date
Tshepang Mbambo a1603f1859 noise 2025-05-10 13:48:45 +02:00
Tshepang Mbambo 330cb46b36 we are a collective 2025-05-10 13:48:35 +02:00
Tshepang Mbambo 9f710fd775 bump edition 2025-05-10 13:47:31 +02:00
Tshepang Mbambo f99df9199f no point versioning these
They are internal tools.
2025-05-10 13:47:31 +02:00
Tshepang Mbambo 7fa4f19ab4 add missing word 2025-05-10 13:14:38 +02:00
Tshepang Mbambo ed9122f534 add rustfmt settings file 2025-03-30 00:31:44 +02:00
Noah Lev d85deb6064 Opt into, rather than out of, linkcheck (#2180)
This makes it less of a hassle to render the book locally.
2024-12-30 17:22:22 +08:00
Martin Liška c609846601 Remove properly tracked config file from .gitignore & add support for skipping of link-checking (#2023)
* Remove properly tracked config file from .gitignore

The file is part of the git history and is a configuration file.

Fixes: #2018

* Add  env. variable support

* Refactoring

* Really skip linkcheck if requested
2024-12-29 13:23:49 -08:00
Martin Liška 0d9aca4ccd Start using mdbook-linkcheck2 (#2103) 2024-12-28 15:00:32 -08:00
Noah Lev 7d522989ff Disable linkcheck in PRs until bugs are fixed
See https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/77
and https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/86.

These bugs are causing linkcheck to erroneously fail because we run it
using `-f`, to avoid too many requests. For now, disable linkcheck in PR
CI, though leave it enabled in the cron job, where the bug should not
occur.
2024-08-07 20:32:37 -07:00
Martin Liška f8fae75c0c linkcheck: fix filtering of the source files (#2019) 2024-08-03 13:42:26 -03:00
Noah Lev d3f43d361d Bump all other deps 2024-07-09 08:20:59 +02:00
Noah Lev ebcd5e63fb Fix chrono deprecations 2024-07-09 08:20:59 +02:00
Noah Lev 90b02a9ab8 Bump chrono
The specific reason I decided to update is since newer versions of
chrono don't depend on time 0.1, which has some soundness issues.
Of course, staying up-to-date in general is a good idea.
2024-07-09 08:20:59 +02:00
Nilstrieb 023c0f2592 Delete length check (#1952)
It's super annoying to be forced to use this bad convention, and
apparently everyone agrees. The only reason no improvements have been
done is because those were blocked on writing a better checker.

I strongly believe that no checker is better than a bad checker, so
let's just delete it in the meantime. I kindly asked anyone who sees
this to complain about overly long sentences in review in the future, I
think we can make this turn out fine.
2024-03-30 17:46:30 +01:00
jyn c6cd62cf77 Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn b4b007be06 Don't require $GITHUB_TOKEN to build locally (#1652) 2023-03-27 00:28:07 +09:00
Tshepang Mbambo 12f5d8d84f have checkboxes only point to date-check lines in files (#1603)
They currently also point to filenames, which is redundant.

current

- [ ] thir.md
  - [ ] line 7: 2022-04
  - [ ] line 60: 2022-08
- [ ] traits/chalk.md
  - [ ] line 4: 2022-05

proposed

- thir.md
  - [ ] line 7: 2022-04
  - [ ] line 60: 2022-08
- traits/chalk.md
  - [ ] line 4: 2022-05
2023-02-16 20:38:25 -08:00
Tshepang Mbambo dc6fcaeae8 address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1428#discussion_r948143840
2022-08-25 19:56:58 -07:00
Tshepang Mbambo 23ae7bb49f make date-check more easy to use
One could not run it like the following, for the would be a panic:

    cargo run --manifest-path ci/date-check/Cargo.toml .

Also, remove the need to specify argument, in which case, current_dir
is assumed.
2022-08-25 19:56:58 -07:00
Tshepang Mbambo 81334fcda4 update date-check format on github issue (#1416)
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-09 14:49:43 -07:00
Tshepang Mbambo 7910832e02 date-check: be more strict 2022-08-02 17:22:34 -04:00
Tshepang Mbambo 8194045511 make date-check more lightweight (#1394)
* make date-check lightweight

This avoids having to write the date twice when updating date-check.

Before "As of <-- 2022-07 --> July 2022"
After "As of July 2022"

* please clippy

* update date-check docs

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042163557

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042167261

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#issuecomment-1189105017

* this breaks markdown

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018268

This led to a more robust regex, though making the tool more picky.
It also found a wrong date format that was missed.

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018419

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018816

* accept review suggestion

This was reverted by mistake

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934019395

* use a more simple fn

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018981

Much more clean

* nit

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
dependabot[bot] 123efb6fc2 Bump regex from 1.4.3 to 1.5.5 in /ci/date-check (#1364)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-06-07 08:40:42 +09:00
Noah Lev 4c4d9b5357 Update author field 2021-10-21 15:13:09 -05:00
Noah Lev 9334db680b Switch date-check to Rust 2021
No migrations were necessary.
2021-10-21 15:13:09 -05:00
Noah Lev 52a33e718d date-check: Recognize capitalized 'Date' as well
Now, if people use 'Date' instead of 'date', it won't be ignored.
2021-08-26 18:53:17 -05:00
Joshua Nelson 34a1658c55 Link to Zulip search for finding the most recent check-in (#1118) 2021-04-29 17:40:25 -03:00
JohnTitor 1f796c2929 Remove the possible unnecessary flag 2021-04-27 13:15:39 -04:00
Yuki Okushi ee94932928 Replace some Travis-related things completely 2021-04-27 13:15:39 -04:00
Yuki Okushi 9930c8bd21 Check `BASE_SHA` only if it's a PR (#1083) 2021-03-11 15:50:34 +01:00
Yuki Okushi 6dab96d7ea Switch from Travis to GHA (#1073) 2021-03-10 11:51:56 -05:00
Santiago Pastorino acd1390adb Make check-in.sh output in way that suggest to add only the most relevant info 2021-02-04 10:10:08 -05:00
Camelid fe8a704c7e Implement date-checker
This tool looks for HTML comments like `<!-- date: 2021-01 -->` in each
Markdown source file and compiles a list of dates that are older than
six months. It then opens an issue with that list, with checkboxes for
each file and date. Note that it will only open an issue if there was at
least one date older than six months; it does nothing if the list is
empty.

This tool is automatically run monthly in a GitHub Actions workflow.
I have tested the tool on a private repo and confirmed that it works.
2021-02-03 19:29:07 -05:00
Joshua Nelson 2e19c8ecc0 Document how to stabilize a library feature (#1036)
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter

* Document how to stabilize a library feature

Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.

* Fix wrong glob

By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
Joshua Nelson a64e819af8 Improve contributor experience for the dev-guide itself (#973)
- Fix typos in the README
- Don't echo all instructions in the linkcheck.sh shellscript; this is
  noisy and unhelpful when developing locally. Verbose output is still
  enabled in CI.
- Link to the index page for compiler docs, not `rustc_middle`. Note
  that the compiler docs are not a guide - that's us!
- Remove outdated instructions about avoiding 429s. These should no
  longer be occurring locally now that we're using caching.
- Consolidate info about `mdbook` and `mdbook-linkcheck` near each other
2020-11-30 11:08:32 -03:00
mark 5643607b1b don't use cache while running PR builds 2020-11-23 18:42:24 -05:00
Joshua Nelson 123c2a51aa fix formatting 2020-10-22 09:08:04 -04:00
Joshua Nelson 760c7edc03 Improve markdown formatting 2020-10-22 09:08:04 -04:00
Joshua Nelson 3f9ed29687 Add a `check-in.sh` script to automate writing markdown links
Example usage:

```
$ ./check-in.sh
usage: ./check-in.sh <since> <number-of-prs-merged>
$ ./check-in.sh 2020-09-03
usage: ./check-in.sh <since> <number-of-prs-merged>
help: you can find the number of PRs merged at https://github.com/rust-lang/rustc-dev-guide/pulls?q=is%3Apr+is%3Aclosed+updated%3A%3E2020-09-03
$ ./check-in.sh 2020-09-03 72
Authors:
- **@1c3t3a**
- **@arora-aman**
... snip ...
Changes:
- Replace links to `buildbot2.r-l.o` with `bors.r-l.o` [#929](https://github.com/rust-lang/rustc-dev-guide/pull/929)
- Add reference PRs for `r?` and `r+` comments [#928](https://github.com/rust-lang/rustc-dev-guide/pull/928)
... snip ...
Changes in progress:
```
2020-10-22 09:08:04 -04:00
Who? Me?! 7f22d040f8 Better error message
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-10-08 17:11:36 -04:00
Who? Me?! b10bdb58f4 Lol logic is hard
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
mark b2ba3d1c14 add assert 2020-10-08 17:11:36 -04:00
Who? Me?! 26c1c5ddce More debuggable bash settings
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
Who? Me?! 7369dc03da Add comment referring to travis docs
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
mark 6ba01cf9eb linkcheck only for changed files except in cron jobs 2020-10-08 17:11:36 -04:00
Joshua Nelson 3f1414cb00 Recommend setting up `check_line_lengths` as a pre-commit script
I've run into lots of annoying failures from this.

- Make it runnable without arguments
- Add it in the README
2020-10-01 01:27:11 -04:00
Mark Mansi 0740d946f7 use cargo install 2020-01-30 21:47:13 -06:00
Mark Mansi 2d8434cec3 remove all the hacks, add some improvements 2019-11-05 11:58:33 -06:00
Amanjeev Sethi 16e931f43e Refactor (build CI script): minimizes the script, thanks to mark-i-m 2019-10-04 16:32:47 -05:00