Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
liamcain authored Jun 1, 2022
2 parents 2cf696e + 7b370b8 commit 256a8d8
Show file tree
Hide file tree
Showing 4 changed files with 1,308 additions and 1,227 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/validate-plugin-entry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ jobs:
console.log('Found issue: ' + error);
};
if (context.payload.pull_request.additions <= context.payload.pull_request.deletions) {
// Don't run any validation checks if the user is just modifying existing plugin config
return;
}
if (context.payload.pull_request.changed_files > 1) {
addError('You modified files other than `community-plugins.json`.');
}
Expand Down Expand Up @@ -83,7 +88,7 @@ jobs:
addError('Your latest Release is missing the `manifest.json` file.');
}
} catch (e) {
addError(`It seems like you made a typo in the repository field \`${plugin.repo}\`.\n<details><summary>Log</summary><pre>${escapeHtml(e.toString())}</pre></details>`);
addError(`Unable to find a release with the tag "${manifest.version}". Make sure that the manifest.json file in your repo points to the correct Github Release\n<details><summary>Log</summary><pre>${escapeHtml(e.toString())}</pre></details>`);
}
}
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,10 @@ To add your plugin to the list, make a pull request to the `community-plugins.js
- If your `manifest.json` requires a version of Obsidian that's higher than the running app, your `versions.json` will be consulted to find the latest version of your plugin that is compatible.
- When the user chooses to install your plugin, Obsidian will look for your GitHub releases tagged identically to the version inside `manifest.json`.
- Obsidian will download `manifest.json`, `main.js`, and `styles.css` (if available), and store them in the proper location inside the vault.

### Announcing the First Public Release of your Plugin/Theme

- Once admitted to the plugin/theme browser, you can announce the public availability of your plugin/theme:
- [in the forums](https://forum.obsidian.md/c/share-showcase/9) as a showcase, and
- [on the Discord Server](https://discord.gg/veuWUTm) in the channel `#updates`. (You need the `developer` role to be able to post in that channel; [you can get that role here](https://discord.com/channels/686053708261228577/702717892533157999/830492034807758859).)
- You can also announce the first working version of your plugin as a public beta before "officially" submitting it to the plugin/theme browser. That way, you can acquire some beta testers for feedback. It's recommended to use the [BRAT Plugin](https://obsidian.md/plugins?id=obsidian42-brat) to make the installation as easy as possible for interested beta testers.
Loading

0 comments on commit 256a8d8

Please sign in to comment.