Mike McQuaid
a707c708c1
Fix/reenable brew style docs
...
- start running this check again
- check the `docs` basename correctly
- use a different name (to a symlink) for the docs rubocop
configuration so that path relativity is done correctly:
https://docs.rubocop.org/rubocop/configuration.html#path-relativity
- add more wildcards to fix docs rubocop exclusions
2024-06-13 12:31:47 +01:00
Mike McQuaid
ca2ac3dd06
workflows/docs: temporarily disable brew style docs check.
2024-06-13 09:55:31 +01:00
dependabot[bot]
2785cfe75a
build(deps): bump ruby/setup-ruby from 1.179.1 to 1.180.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.179.1 to 1.180.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](78c01b705f...ff740bc00a
2024-06-12 18:43:58 +00:00
Mike McQuaid
faedd41dfb
docs: more workflow improvements.
...
- Add a special step to handle formulae.brew.sh API samples generation.
- Ignore the root URL: it always works and often is a false-positive
failure.
While we're here:
- Autofix some RuboCop offenses in the Rakefile.
2024-06-11 13:53:16 +01:00
Mike McQuaid
35b3be3625
workflows/docs: allow reading GitHub Pages.
...
This isn't technically needed for Homebrew/brew but is needed for
private repositories that reuse this workflow.
2024-06-11 12:49:45 +01:00
Mike McQuaid
0fc7cd94be
workflows/docs: various tweaks.
...
- don't limit the entire job to Homebrew/brew (so it can be synced by
Homebrew/.github sync jobs)
- always checkout the current repository (as it may not be Homebrew/brew
and, when it is, it doesn't take too long anyway)
- only need to do cleanup for Homebrew/brew
- run Vale as separate step
- fix working directory handling
2024-06-11 11:06:57 +01:00
Mike McQuaid
910000f31d
github/workflows: split RubyDoc CI job.
...
This will allow syncing the documentation CI job to other repositories
with `docs` folders in https://github.com/Homebrew/.github/pull/121 .
2024-06-10 11:59:54 -07:00
dependabot[bot]
25b10286f8
build(deps): bump ruby/setup-ruby from 1.179.0 to 1.179.1
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.179.0 to 1.179.1.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](d5fb7a202f...78c01b705f
2024-06-08 15:19:25 +00:00
dependabot[bot]
2b2c34e3f7
build(deps): bump ruby/setup-ruby from 1.178.0 to 1.179.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.178.0 to 1.179.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](0cde4689ba...d5fb7a202f
2024-06-03 16:05:41 +00:00
dependabot[bot]
336abf239a
build(deps): bump ruby/setup-ruby from 1.177.1 to 1.178.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.177.1 to 1.178.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](943103cae7...0cde4689ba
2024-05-30 16:12:36 +00:00
Mike McQuaid
3392226a10
Include more Ruby metadata files
...
- include `.ruby-version` and in the project root (and unignore in
`.gitignore`) to improve editor support which expects these files
- use the `.ruby-version` in `docs/Gemfile` to use a consistent Ruby
version here
- remove hardcoded Ruby versions from `workflows/docs` in favour of
using the `.ruby-version` file instead
- use more consistent configuration in `workflows/docs` to match
`workflows/tests`
2024-05-23 16:29:14 +01:00
dependabot[bot]
6ca9f1949a
---
...
updated-dependencies:
- dependency-name: ruby/setup-ruby
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
2024-05-22 16:48:14 +00:00
Patrick Linnane
7d51384d10
build(deps): bump ruby/setup-ruby from 1.176.0 to 1.177.0
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-20 07:34:21 -07:00
dependabot[bot]
d4a387a374
build(deps): bump ruby/setup-ruby from 1.175.1 to 1.176.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.175.1 to 1.176.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](1198b07430...cacc9f1c0b
2024-05-03 14:08:31 +00:00
Markus Reiter
480e264d9a
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
dependabot[bot]
99f0b0b310
build(deps): bump ruby/setup-ruby from 1.175.0 to 1.175.1
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.175.0 to 1.175.1.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](70da3bbf44...1198b07430
2024-04-26 18:20:24 +00:00
dependabot[bot]
a99e168201
build(deps): bump ruby/setup-ruby from 1.174.0 to 1.175.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.174.0 to 1.175.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](6bd3d993c6...70da3bbf44
2024-04-23 18:34:35 +00:00
dependabot[bot]
2a627890c8
build(deps): bump ruby/setup-ruby from 1.173.0 to 1.174.0
...
Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby ) from 1.173.0 to 1.174.0.
- [Release notes](https://github.com/ruby/setup-ruby/releases )
- [Commits](5f19ec79ce...6bd3d993c6
2024-04-16 18:46:06 +00:00
Mike McQuaid
1bba1955f1
workflows/docs: improve another setup-ruby pin comment.
...
Co-authored-by: Bo Anderson <mail@boanderson.me>
2024-04-15 08:34:21 +01:00
Mike McQuaid
72f1558785
workflows/docs: improve setup-ruby pin comment.
...
Co-authored-by: Bo Anderson <mail@boanderson.me>
2024-04-15 08:34:02 +01:00
Thierry Moisan
bc6078ded5
workflow/docs.yml: pin setup-ruby action
2024-04-14 18:04:46 -04:00
Issy Long
00b47d1fec
Teach brew style about docs/.rubocop.yml
...
- Yes, we have yet another `.rubocop.yml` but in-line exclusions in
`<span class="display:none;">` in the Markdown seemed more ugly.
- This needed tweaks to `brew style` to make it read the new config
file when we're scanning docs.
2024-01-24 00:01:45 +00:00
Issy Long
1fe968e937
Run brew style for docs as part of the docs CI job
...
- Let's see how this goes.
2024-01-24 00:01:40 +00:00
Bo Anderson
8a90d829e2
workflows/docs: bump rubydoc test Ruby
2023-11-07 15:20:29 +00:00
Issy Long
210b678caf
The test task already runs build, so no need for it twice
2023-09-01 01:12:34 +01:00
Issy Long
c18980d20d
Run the docs site's broken link checker in the docs linting CI job
...
- We had `rake test` as a task, but we never actually ran it in CI or
anywhere before building the site.
- The `html-proofer` gem
[only supports Ruby 3.1](https://github.com/gjtorikian/html-proofer/blob/main/html-proofer.gemspec#L20 ),
so I bumped the linting job to use Ruby 3.1 across the board.
- This will make things slower (or maybe it's taking ages because of my
dodgy hotel internet connection), maybe we should only run it on a
schedule as a separate job?
- Fixes https://github.com/Homebrew/brew/issues/ 15908.
2023-09-01 01:01:01 +01:00
Mike McQuaid
5121567a9a
workflows: improve setup-homebrew and API usage.
...
- `HOMEBREW_NO_INSTALL_FROM_API` was passed in a few places
unnecessarily
- https://github.com/Homebrew/actions/pull/393 will change the default
behaviour of setup-homebrew so let's be explicit to speed things up
and avoid changes when it's merged
2023-07-06 16:54:06 +01:00
Douglas Eichelberger
200b5cad6a
Minor YARD improvements
2023-04-05 10:06:45 -07:00
Bo Anderson
dc2f41cb8d
workflows: set working directory to repo location
2023-01-27 01:48:26 +00:00
Douglas Eichelberger
794b839e36
Fix remaining YARD exception
2023-01-12 09:56:05 -08:00
EricFromCanada
d9ef454528
CI: add docs.yml
...
With fixes for Markdown syntax to allow tests to pass.
2022-11-26 10:28:12 -05:00
