From d242cb3a1e2fd4003d97c980f328eee9bd1ba015 Mon Sep 17 00:00:00 2001 From: Matthew Mayer Date: Tue, 24 Oct 2017 18:37:35 -0700 Subject: [PATCH 1/3] Update README to use precompiled binaries. --- README.md | 36 +++++++++++++++++++++++------------- TDD-notes.md | 26 -------------------------- 2 files changed, 23 insertions(+), 39 deletions(-) delete mode 100644 TDD-notes.md diff --git a/README.md b/README.md index 4d7ad03..eb46e27 100644 --- a/README.md +++ b/README.md @@ -17,18 +17,11 @@ repos ready for a production release. +## Acquiring -## Running - -### Compile and run - -`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE"` - -### Compile then run - -`cargo build` +Prebuilt binaries for Linux and OSX are available on [the releases page](https://github.com/matthewkmayer/release-party-BR/releases). -`RP_GITHUBTOKEN=your_personal_token_here ./target/debug/release-party-br --org "ORGHERE"` +## Running ### Required environment variables @@ -45,7 +38,24 @@ Say what PRs to create without actually creating them: The `ignoredrepos.toml` file can contain a list of repositories to ignore. See [ignoredrepos.toml](ignoredrepos.toml) for an example. -### Optional: compile in release mode +### Running on OSX + +`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-darwin-amd64 --org "ORGHERE"` + +### Running on Linux + +`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-linux-amd64 --org "ORGHERE"` + +## Building from source + +Clone the repo, have Rust installed, etc... + +### Compile and run + +`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE"` + +### Compile then run + +`cargo build` -Run `cargo build --release` to create a release binary. This will run faster than a debug build. The binary will be created at -`./target/release/release-party-br`. \ No newline at end of file +`RP_GITHUBTOKEN=your_personal_token_here ./target/debug/release-party-br --org "ORGHERE"` \ No newline at end of file diff --git a/TDD-notes.md b/TDD-notes.md deleted file mode 100644 index 573614a..0000000 --- a/TDD-notes.md +++ /dev/null @@ -1,26 +0,0 @@ -# Bug to fix - -https://github.com/matthewkmayer/release-party-BR/issues/62 - -``` -RP_GITHUBTOKEN=ghtoken release-party-br --org "https://api.github.com/orgs/ORG-HERE/repos" -thread 'main' panicked at 'expected repos: "Couldn\'t deserialize repos from github: invalid type: map, expected a sequence at line 1 column 1"', src/libcore/result.rs:860:4 -note: Run with `RUST_BACKTRACE=1` for a backtrace. -``` - -# Goal - -TDD this fix. - -## More goal - -TDD a "did you mean x" response. - -# Lookin' good! - -``` -RP_GITHUBTOKEN=foo cargo run -- --org https://api.github.com/orgs/my-org-name/repos - Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs - Running `target/debug/release-party-br --org 'https://api.github.com/orgs/my-org-name/repos'` -thread 'main' panicked at 'Try this for the org value: Try this: my-org-name', src/main.rs:66:30 -``` \ No newline at end of file From 8558f620772dfdbfd785493a35dcfd5496f33888 Mon Sep 17 00:00:00 2001 From: Matthew Mayer Date: Tue, 24 Oct 2017 18:39:32 -0700 Subject: [PATCH 2/3] Trim more from README --- README.md | 26 ++++++-------------------- 1 file changed, 6 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index eb46e27..a9f1d17 100644 --- a/README.md +++ b/README.md @@ -23,39 +23,25 @@ Prebuilt binaries for Linux and OSX are available on [the releases page](https:/ ## Running -### Required environment variables +#### Required environment variables `RP_GITHUBTOKEN` - a personal access token to Github -### Optional: dry-run +#### Optional: dry-run Say what PRs to create without actually creating them: `RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE" --dry-run` -### Optional: repo ignore list +#### Optional: repo ignore list The `ignoredrepos.toml` file can contain a list of repositories to ignore. See [ignoredrepos.toml](ignoredrepos.toml) for an example. -### Running on OSX +#### Running on OSX `RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-darwin-amd64 --org "ORGHERE"` -### Running on Linux +#### Running on Linux -`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-linux-amd64 --org "ORGHERE"` - -## Building from source - -Clone the repo, have Rust installed, etc... - -### Compile and run - -`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE"` - -### Compile then run - -`cargo build` - -`RP_GITHUBTOKEN=your_personal_token_here ./target/debug/release-party-br --org "ORGHERE"` \ No newline at end of file +`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-linux-amd64 --org "ORGHERE"` \ No newline at end of file From e15a2a527ec214f596de40021e9801f86965dcb7 Mon Sep 17 00:00:00 2001 From: Matthew Mayer Date: Tue, 24 Oct 2017 18:41:45 -0700 Subject: [PATCH 3/3] More README refactoring. --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a9f1d17..2b5baa1 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,15 @@ Prebuilt binaries for Linux and OSX are available on [the releases page](https:/ ## Running -#### Required environment variables +#### Required information -`RP_GITHUBTOKEN` - a personal access token to Github +* `RP_GITHUBTOKEN` - environment variable for a personal access token to Github +* `--org` - GitHub organization name -#### Optional: dry-run +#### Optional behavior -Say what PRs to create without actually creating them: - -`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE" --dry-run` - -#### Optional: repo ignore list - -The `ignoredrepos.toml` file can contain a list of repositories to ignore. See [ignoredrepos.toml](ignoredrepos.toml) -for an example. +* `dry-run` - See what PRs would be created: `RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE" --dry-run` +* repo ignore list - The `ignoredrepos.toml` file can contain a list of repositories to ignore. See [ignoredrepos.toml](ignoredrepos.toml) for an example. #### Running on OSX