Skip to content
This repository has been archived by the owner on Sep 2, 2019. It is now read-only.

Commit

Permalink
Rename USERNAME to REPO_OWNER
Browse files Browse the repository at this point in the history
at Joe's suggestion, it's more clear.
  • Loading branch information
SeanTAllen committed Aug 5, 2019
1 parent 82eb2ab commit 888a2f2
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .ci-scripts/release.bash
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
set -o errexit
set -o nounset

USERNAME="{USERNAME}"
REPO_OWNER}"
REPO="{REPO}"
GITHUB_USER="{GITHUB_USER}"
Expand Down Expand Up @@ -70,7 +70,7 @@ json=$(jq -n \
echo "Uploading release notes..."
result=$(curl -X POST "https://api.github.com/repos/${USERNAME}/${REPO}/releases" \
result=$(curl -X POST "https://api.github.com/repos/${REPO_OWNER}/${REPO}/releases" \
-H "Content-Type: application/x-www-form-urlencoded" \
-u "${GITHUB_USER}:${GITHUB_TOKEN}" \
--data "${json}")
Expand Down
4 changes: 2 additions & 2 deletions .ci-scripts/upload-release-documentation-to-main-actor.bash
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
set -eu

# Needs to be supplied
USERNAME="{USERNAME}"
REPO_OWNER="{REPO_OWNER}"
PACKAGE_NAME="{PACKAGE}"
GITHUB_USER="{GITHUB_USER}"

Expand Down Expand Up @@ -33,7 +33,7 @@ DOCS_DIR="${GEN_MD}/${PACKAGE_NAME}/${TAG}"
# Generated markdown repo
echo "Cloning main.actor-package-markdown repo into ${GEN_MD}"
git clone \
"https://${GITHUB_TOKEN}@github.com/${USERNAME}/main.actor-package-markdown.git" \
"https://${GITHUB_TOKEN}@github.com/${REPO_OWNER}/main.actor-package-markdown.git" \
"${GEN_MD}"

# Make the docs
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Additional notes regarding formatting:

## Bug report

First of all please [search existing issues](https://github.com/{USERNAME}/{REPO}/issues) to make sure your issue hasn't already been reported. If you cannot find a suitable issue — [create a new one](https://github.com/{USERNAME}/{REPO}/issues/new).
First of all please [search existing issues](https://github.com/{REPO_OWNER}/{REPO}/issues) to make sure your issue hasn't already been reported. If you cannot find a suitable issue — [create a new one](https://github.com/{REPO_OWNER}/{REPO}/issues/new).

Provide the following details:

Expand All @@ -34,11 +34,11 @@ This project uses a fairly standard GitHub pull request workflow. If you have al

Here is the basic GitHub workflow:

1. Fork this repo. you can do this via the GitHub website. This will result in you having your own copy of the repo under your GitHub account.
1. Fork this repo. you can do this via the GitHub website. This will result in you having your own copy of the repo under your GitHub account.
2. Clone your forked repo to your local machine
3. Make a branch for your change
4. Make your change on that branch
5. Push your change to your repo
5. Push your change to your repo
6. Use the github ui to open a PR

Some things to note that aren't immediately obvious to folks just starting out:
Expand Down Expand Up @@ -78,7 +78,7 @@ Documentation is not "source code." As such, it should not be wrapped at 80 colu

All code examples in documentation should be formatted in a fashion appropriate to the language in question.

All command line examples in documentation should be presented in a copy and paste friendly fashion. Assume the user is using the `bash` shell. GitHub formatting on long command lines can be unfriendly to copy-and-paste. Long command lines should be broken up using `\` so that each line is no more than 80 columns. Wrapping at 80 columns should result in a good display experience in GitHub. Additionally, continuation lines should be indented two spaces.
All command line examples in documentation should be presented in a copy and paste friendly fashion. Assume the user is using the `bash` shell. GitHub formatting on long command lines can be unfriendly to copy-and-paste. Long command lines should be broken up using `\` so that each line is no more than 80 columns. Wrapping at 80 columns should result in a good display experience in GitHub. Additionally, continuation lines should be indented two spaces.

OK:

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Status

[![CircleCI](https://circleci.com/gh/{USERNAME}/{REPO}.svg?style=svg)](https://circleci.com/gh/{USERNAME}/{REPO})
[![CircleCI](https://circleci.com/gh/{REPO_OWNER}/{REPO}.svg?style=svg)](https://circleci.com/gh/{REPO_OWNER}/{REPO})

{PROJECT_STATUS}

Expand All @@ -14,9 +14,9 @@
* Update your `bundle.json`

```json
{
{
"type": "github",
"repo": "{USERNAME}/{REPO}"
"repo": "{REPO_OWNER}/{REPO}"
}
```

Expand Down
4 changes: 2 additions & 2 deletions RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before getting started, you will need a number for the version that you will be
Please note that the release script was written with the assumption that you are using a clone of the `{REPO}` repo. You have to be using a clone rather than a fork. Further, due to how git works, you need to make sure that both your `master` branch is up-to-date. It is advised to your do this but making a fresh clone of the `{REPO}` repo from which you will release. For example:

```bash
git clone [email protected]:{USERNAME}/{REPO}.git {REPO}-release-clean
git clone [email protected]:{REPO_OWNER}/{REPO}.git {REPO}-release-clean
cd {REPO}-release-clean
```

Expand All @@ -42,7 +42,7 @@ bash release.bash seantallen 9999998gk48888ddd78a9fd12345a12870987uk \
Navigate to the GitHub page for the release you just created. It will be something like:

```
https://github.com/{USERNAME}/{REPO}/releases/tag/0.3.1
https://github.com/{REPO_OWNER}/{REPO}/releases/tag/0.3.1
```

Copy the url to the page. You'll need it for the next two steps.
Expand Down
2 changes: 1 addition & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Additionally, the CONTRIBUTING.md assumes your project is hosted on GitHub and c

This repository is templated. You'll want to replace anything in {} with the correct value. The following replacement values are required:

- {USERNAME}: your GitHub username or organization name, for example: `ponylang`.
- {REPO_OWNER}: your GitHub username or organization name, for example: `ponylang`.
- {REPO}: the name of your repository, for example: `ponyc`.
- {PACKAGE}: the name of your libraries package, for example: `msgpack`.
- {COC_EMAIL}: email address that Code of Conduct violations should be reported to, for example: `[email protected]`.
Expand Down
4 changes: 2 additions & 2 deletions release.bash
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
set -o errexit
set -o nounset

USERNAME="{USERNAME}"
REPO_OWNER="{REPO_OWNER}"
REPONAME="{REPO}"

verify_args() {
Expand Down Expand Up @@ -91,7 +91,7 @@ json=$(jq -n \
--arg body "$body" \
"${jsontemplate}")

curl -X POST "https://api.github.com/repos/${USERNAME}/${REPO}/releases" \
curl -X POST "https://api.github.com/repos/${REPO_OWNER}/${REPO}/releases" \
-H "Content-Type: application/x-www-form-urlencoded" \
-u "${ghuser}:${ghtoken}" \
--data "${json}"

0 comments on commit 888a2f2

Please sign in to comment.