Commit Graph

60 Commits

Author SHA1 Message Date
Yuki Okushi 674f73da63
Switch from Travis to GHA (#1073) 2021-03-10 11:51:56 -05:00
Santiago Pastorino be872c1ce3 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 5118b6b865 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 bd008cc786
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 e66adf6bb5
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 8ebb338abb don't use cache while running PR builds 2020-11-23 18:42:24 -05:00
Joshua Nelson 132df6222b fix formatting 2020-10-22 09:08:04 -04:00
Joshua Nelson 8539c7f4e2 Improve markdown formatting 2020-10-22 09:08:04 -04:00
Joshua Nelson e75c72baa3 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?! 647d5620f9 Better error message
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-10-08 17:11:36 -04:00
Who? Me?! 28a5c3588d Lol logic is hard
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
mark d3134dd9a9 add assert 2020-10-08 17:11:36 -04:00
Who? Me?! 6361b425d8 More debuggable bash settings
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
Who? Me?! 19f70c2e60 Add comment referring to travis docs
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08 17:11:36 -04:00
mark 0419c55271 linkcheck only for changed files except in cron jobs 2020-10-08 17:11:36 -04:00
Joshua Nelson 4a6fd1131b 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 a136b4b6c4 use cargo install 2020-01-30 21:47:13 -06:00
Mark Mansi 73f6cdfe3e remove all the hacks, add some improvements 2019-11-05 11:58:33 -06:00
Amanjeev Sethi 522bcb43c6 Refactor (build CI script): minimizes the script, thanks to mark-i-m 2019-10-04 16:32:47 -05:00
Amanjeev Sethi 171f7f785a Fix (build CI script): fails early if linkcheck fails 2019-10-04 16:32:47 -05:00
Amanjeev Sethi feb3229dbf Fix (build CI script):
* Removes timeout hack because it is not needed because we have upgraded mdbook_linkcheck
* Renamed build script because it is no longer ignoring timeouts
2019-10-04 16:32:47 -05:00
Amanjeev Sethi 7b699b91a6 Revert "Removes timeout script so CI does not have false positives"
This reverts commit c3ed0a1ef9.
2019-10-04 16:32:47 -05:00
Amanjeev Sethi fc8ea86c61 Removes timeout script so CI does not have false positives 2019-10-04 16:32:47 -05:00
Mark Mansi 941968db2f hack + drive-by-fix 2019-09-05 19:04:33 -05:00
Michael Bryan 5959ff2655 Updated the mdbook-linkcheck version 2019-09-05 17:03:24 -05:00
Who? Me?! b7f24940c0 fix broken link (#421) 2019-08-13 11:56:02 -03:00
Who? Me?! 6f4ba673ff Remove leading new line 2019-08-06 17:18:07 -05:00
Who? Me?! d420542602 hack around timeouts (#416) 2019-08-05 17:57:25 -03:00
Who? Me?! 7f7d1d8eae Update install.sh 2019-07-19 11:37:20 -05:00
Who? Me?! 382f1c4867 Update mdbook 2019-07-19 11:37:20 -05:00
Who? Me?! d16c32661a Update to mdbook-linkcheck 0.3.0 2019-06-24 09:52:03 -05:00
Who? Me?! 9f3678dece Update mdbook 2019-06-24 09:52:03 -05:00
Mark Mansi 0456aaa9e1 update mdbook 2019-03-01 17:16:50 -06:00
Who? Me?! 3a804956e3
make the line-length script respect 100 char limit XD (#240)
🤣 🤣 🤣
2018-11-26 11:13:21 -06:00
Who? Me?! ade4a4ec47 Don't keep recompiling! 2018-11-09 19:37:59 -06:00
Mark Mansi 766a5e354d use the right version of mdbook linkcheck 2018-09-21 15:54:25 -05:00
Mark Mansi ba5c94015d use new mdbook-linkcheck version 2018-09-21 15:54:25 -05:00
Mark Mansi 6e7e4d2d35 use mdbook 0.2 2018-09-21 15:54:25 -05:00
Niko Matsakis a72a068722 bump max line length to 100
otherwise our summary.md doesn't fit
2018-09-11 16:31:47 -04:00
Eric Huss a154eb9549 Update mdbook
Closes #138
Closes #160
2018-07-09 21:35:58 -05:00
Mark Mansi 37c68dbbdd allow long relative links 2018-06-02 17:20:47 -04:00
Mark Mansi e5bed18895 update to mdbook 0.1.7 2018-05-08 12:44:02 -05:00
Niko Matsakis aeef4cd9b3 make the script give more useful feedback 2018-03-26 20:28:00 -05:00
Alexander Regueiro e6acd30581 Hard-wrapped lines that are too long. 2018-03-26 20:28:00 -05:00
Alexander Regueiro ba057b34ad Ignore line check on certain types of lines or in certain blocks. 2018-03-26 20:28:00 -05:00
Alexander Regueiro 61a3f536d1 Added check for all source files to ensure they have no lines longer than 80 chars. 2018-03-26 20:28:00 -05:00
Eric Huss d16bde7fb8 Add mdbook search. 2018-03-22 13:55:55 -05:00
Niko Matsakis df5401ca7a bump mdbook to 0.1.5 2018-03-19 10:41:23 -05:00
Eric Huss 4af21aad89 Force mdbook update on CI if there is a version mismatch.
Fixes #58.
2018-02-17 22:35:40 -06:00
Michael Bryan acf36f823e Removed ghp-import and run mdbook build unconditionally 2018-01-31 14:13:10 -05:00