Skip to content

Commit

Permalink
Rename master branch to main
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Jan 23, 2021
1 parent d93f0bd commit a1aed0a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For more info on how to create plugins, read the [plugins docs](docs/plugins.md)

## Dev builds

Download [`master`](https://kap-artifacts.now.sh/master) or builds for any other branch using: `https://kap-artifacts.now.sh/<branch>`. Note that these builds are unsupported and may have issues.<br>
Download [`main`](https://kap-artifacts.now.sh/main) or builds for any other branch using: `https://kap-artifacts.now.sh/<branch>`. Note that these builds are unsupported and may have issues.

## Related Repositories

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Tip: You can use modern JavaScript features like async/await in your plugin.
- You must have the `kap-plugin` keyword in package.json. Add additional relevant keywords to improve discovery.
- The `"description"` in package.json should succinctly describe what you can do with it. For example: `Share GIFs on GIPHY`. Not something like this: `Kap plugin that uploads GIFs to GIPHY`.
- The readme should follow the style of [`kap-giphy`](https://github.com/wulkano/kap-giphy).
- Your plugin must be tested, preferably using [`kap-plugin-test`](https://github.com/SamVerschueren/kap-plugin-test) and [`kap-plugin-mock-context`](https://github.com/samverschueren/kap-plugin-mock-context). [Example](https://github.com/wulkano/kap-giphy/blob/master/test/test.js).
- Your plugin must be tested, preferably using [`kap-plugin-test`](https://github.com/SamVerschueren/kap-plugin-test) and [`kap-plugin-mock-context`](https://github.com/samverschueren/kap-plugin-mock-context). [Example](https://github.com/wulkano/kap-giphy/blob/main/test/test.js).
- The package.json file can include a `kap` object with the following options:
- `version`: a [semver range](https://nodesource.com/blog/semver-a-primer/) of the Kap versions your plugin supports. Defaults to `*`.
- `macosVersion`: a [semver range](https://nodesource.com/blog/semver-a-primer/) of the macOS versions your plugin supports. Defaults to `*`.
Expand Down Expand Up @@ -112,7 +112,7 @@ The `action` function is where you implement the behavior of your service. The f

Use `context.setProgress()` whenever possible to keep the user updated on what's happening. The `.filePath()` method sets its own progress, so you should not do it for that step.

Example plugins: [`kap-giphy`](https://github.com/wulkano/kap-giphy/blob/master/index.js), [`kap-s3`](https://github.com/SamVerschueren/kap-s3), [`kap-imgur`](https://github.com/kevva/kap-imgur), [`kap-streamable`](https://github.com/kevva/kap-streamable)
Example plugins: [`kap-giphy`](https://github.com/wulkano/kap-giphy/blob/main/index.js), [`kap-s3`](https://github.com/SamVerschueren/kap-s3), [`kap-imgur`](https://github.com/kevva/kap-imgur), [`kap-streamable`](https://github.com/kevva/kap-streamable)

### Edit services

Expand Down Expand Up @@ -395,7 +395,7 @@ Sometimes services require an [OAuth](https://oauth.net/2/) flow to retrieve a t

For an example of this flow in action, check out [kap-dropbox](https://github.com/karaggeorge/kap-dropbox).

If the API provider only allows HTTP/HTTPS URLs, or if you don't want to do the code exchange in the plugin (to avoid having the secret in the code), you might need to create a proxy, similar to the [one used for kap-dropbox](https://github.com/karaggeorge/kap-dropbox/tree/master/oauth-proxy), to trigger the deep link.
If the API provider only allows HTTP/HTTPS URLs, or if you don't want to do the code exchange in the plugin (to avoid having the secret in the code), you might need to create a proxy, similar to the [one used for kap-dropbox](https://github.com/karaggeorge/kap-dropbox/tree/main/oauth-proxy), to trigger the deep link.

## Removing your Kap plugin

Expand Down
9 changes: 3 additions & 6 deletions maintaining.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Maintaining


## Developing Kap

Run `yarn dev` in one terminal tab to start watch mode, and in another tab, run `yarn start` to launch Kap.

We strongly recommend installing an [XO editor plugin](https://github.com/sindresorhus/xo#editor-plugins) for JavaScript linting and a [Stylelint editor plugin](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/complementary-tools.md#editor-plugins) for CSS linting. Both of these support auto-fix on save.

We strongly recommend installing an [XO editor plugin](https://github.com/sindresorhus/xo#editor-plugins) for JavaScript linting and a [Stylelint editor plugin](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/integrations/editor.md) for CSS linting. Both of these support auto-fix on save.

## Releasing a new version

Expand All @@ -18,15 +16,14 @@ We strongly recommend installing an [XO editor plugin](https://github.com/sindre
- Leave the `Release title` field blank
- Write release notes
- Click `Save draft`
- Change `version` [here](https://github.com/wulkano/kap/blob/master/package.json#L4) to the new version and use the version number as the commit title (Example: `2.0.0`)
- Change `version` [here](https://github.com/wulkano/kap/blob/main/package.json#L4) to the new version and use the version number as the commit title (Example: `2.0.0`)
- CircleCI will now build the app and add the binaries to the release
- When CircleCI has attached the binaries to the release, click `Edit` on the release, and then click `Publish release`


## Releasing a new beta version

- Check out the `beta` branch: `git checkout beta`
- Rebase from the `master` branch: `git pull --rebase origin master`
- Rebase from the `main` branch: `git pull --rebase origin main`
- Change the `version` number in `package.json`
- Amend the "Beta build customizations" commit: `git add . && git commit --amend`
- Force push to the `beta` branch: `git push --force`
Expand Down

0 comments on commit a1aed0a

Please sign in to comment.