Skip to content

README.md

Latest commit

 

History

History
82 lines (43 loc) · 4.17 KB

README.md

File metadata and controls

82 lines (43 loc) · 4.17 KB

Plugin logo thingie: an app icon, a two-way communications icon, a note icon

Actions URI

This plugin adds additional x-callback-url endpoints to Obsidian for common actions — it's a clean, super-charged addition to the built-in Obsidian URIs, for working with daily notes, notes, getting search results etc.

Documentation

For information about available features and routes please see the documentation.

Bug reports and feature requests are welcome, feel free to open an issue here on GitHub. For discussions, please visit the Plugin Forum ("Log in with GitHub" is enabled).

Plugin Project Status

GitHub release (latest by date) Maturity: Stable Development: Active Support: Active

(Please see Don McCurdy's post "Healthy expectations in open source" for information about the different statuses.)

Installation

  1. Search for "Actions URI" in Obsidian's community plugins browser. (This link should bring it up.)
  2. Install it.
  3. Enable the plugin in your Obsidian settings under "Community plugins".

That's it.

Installation via BRAT (for pre-releases or betas)

  1. Install BRAT.
  2. Add "Actions URI" to BRAT:
    1. Open "Obsidian42 - BRAT" via Settings → Community Plugins
    2. Click "Add Beta plugin"
    3. Use the repository address czottmann/obsidian-actions-uri
  3. Enable "Actions URI" under Settings → Options → Community Plugins

Development

This project uses pnpm (pinned via packageManager in package.json). Enable it with corepack enable, then clone the repository and run pnpm install --frozen-lockfile to install the dependencies. Afterwards, run pnpm dev to compile and have it watch for file changes.

Releasing

Releases are cut straight from main. The whole flow is driven by bin/tag-release.fish, which requires fish, gum, and jq.

From a clean main with the changes to ship already committed:

bin/tag-release.fish --version 1.9.0 --obsidian-version 1.8.0

--version is the new plugin version; --obsidian-version is the minimum Obsidian version recorded in manifest.json and versions.json. The script bumps the version across package.json, manifest.json, versions.json, src/plugin-info.json, and src/plugin-info.ts, then (after gum confirmation prompts) commits as [REL] Release <version>, tags the commit <version>, and pushes the commit and tag.

Pushing the tag triggers the Release Obsidian Plugin GitHub Actions workflow (.github/workflows/release.yml), which builds the plugin and creates a draft GitHub release with main.js, manifest.json, and a zipped bundle attached. Edit the draft to add release notes and publish it manually.

Author

Carlo Zottmann, carlo@zottmann.dev, https://c.zottmann.dev, https://github.com/czottmann

Projects using Actions URI

  • Actions for Obsidian: Useful new Obsidian actions for the Shortcuts app on macOS and iOS, bridging the gap between your notes and your workflows.

Want to see your project here? Drop me a line! (See "Author" section.)

Thanks to …

  • the obsidian-tasks crew for the "starter templates" for the GitHub Action workflow and the handy release.sh script

License

MIT, see LICENSE.md.