Skip to content

Commit

Permalink
feat: Initial version (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
gr2m authored May 6, 2021
1 parent d6cb414 commit 3c09116
Show file tree
Hide file tree
Showing 8 changed files with 1,041 additions and 2 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Release
on:
push:
branches:
- main

jobs:
release:
name: release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12
- uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm ci
- run: npx semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}
37 changes: 37 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Test
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize]

jobs:
test_matrix:
runs-on: ubuntu-latest
strategy:
matrix:
node_version: ["12", "14"]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node_version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node_version }}
- uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm ci
- run: npm test

# The "test" step can be required in branch protection and does not
# change each time the test matrix changes.
test:
runs-on: ubuntu-latest
needs: test_matrix
steps:
- run: echo ok
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
# 🚧 WORK IN PROGRESS. See [#1](https://github.com/octoherd/script-rename-master-branch-to-main/pull/1) | [Preview](https://github.com/octoherd/script-rename-master-branch-to-main/tree/initial-version)

# script-rename-master-branch-to-main

> Renames the default branch to main if it is currently set to master
[![@latest](https://img.shields.io/npm/v/@octoherd/script-rename-master-branch-to-main.svg)](https://www.npmjs.com/package/@octoherd/script-rename-master-branch-to-main)
[![Build Status](https://github.com/octoherd/script-rename-master-branch-to-main/workflows/Test/badge.svg)](https://github.com/octoherd/script-rename-master-branch-to-main/actions?query=workflow%3ATest+branch%3Amain)

## Usage

Note: Your GitHub account must have owner or admin permission in order to rename the default branch on a repository

Minimal usage

```js
npx @octoherd/script-rename-master-branch-to-main
```

Pass all options as CLI flags to avoid user prompts

```js
npx @octoherd/script-rename-master-branch-to-main \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "octoherd/*"
```

## Options

| option | type | description |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--octoherd-token`, `-T` | string | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set |
| `--octoherd-repos`, `-R` | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |
| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)
Expand Down
6 changes: 6 additions & 0 deletions cli.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/env node

import { script } from "./script.js";
import { run } from "@octoherd/cli/run";

run(script);
Loading

0 comments on commit 3c09116

Please sign in to comment.