Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is a replacement for the rubydoc.info site that has been a bit unreliable for us. Also, note we're using the community Ruby style guide now rather than the GitHub one.
- Loading branch information
1 parent
f1f792e
commit 97e5123
Showing
7 changed files
with
109 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
workflow "Push" { | ||
on = "push" | ||
resolves = ["Generate rubydoc.brew.sh"] | ||
} | ||
|
||
action "Generate rubydoc.brew.sh" { | ||
uses = "docker://ruby:latest" | ||
runs = ".github/main.workflow.sh" | ||
secrets = ["RUBYDOC_DEPLOY_KEY"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
#!/bin/bash | ||
|
||
set -e | ||
|
||
# silence bundler complaining about being root | ||
mkdir ~/.bundle | ||
echo 'BUNDLE_SILENCE_ROOT_WARNING: "1"' > ~/.bundle/config | ||
|
||
# configure git | ||
git config --global user.name "BrewTestBot" | ||
git config --global user.email "homebrew-test-bot@lists.sfconservancy.org" | ||
|
||
# setup SSH | ||
mkdir ~/.ssh | ||
chmod 700 ~/.ssh | ||
echo "$RUBYDOC_DEPLOY_KEY" > ~/.ssh/id_ed25519 | ||
chmod 600 ~/.ssh/id_ed25519 | ||
git config --global core.sshCommand "ssh -i ~/.ssh/id_ed25519 -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" | ||
|
||
# clone rubydoc.brew.sh with SSH so we can push back | ||
git clone git@github.com:Homebrew/rubydoc.brew.sh | ||
cd rubydoc.brew.sh | ||
|
||
# clone latest Homebrew/brew | ||
git clone --depth=1 https://github.com/Homebrew/brew | ||
|
||
# run rake to build documentation | ||
gem install bundler | ||
bundle install | ||
bundle exec rake | ||
|
||
# commit and push generated files | ||
git add docs | ||
git diff --exit-code HEAD -- docs && exit 0 | ||
git commit -m 'docs: update from Homebrew/brew push' docs | ||
git push |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,9 @@ | ||
# Homebrew's Formula API | ||
This is the (partially) documented public API for Homebrew. | ||
|
||
This is the public API for Homebrew. | ||
|
||
The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private. | ||
|
||
You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. | ||
You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide) helpful in creating formulae. | ||
|
||
Good luck! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters