-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
9,605 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
- package-ecosystem: "npm" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
on: | ||
pull_request: | ||
paths: | ||
- '**/*.ts' | ||
- .github/workflows/ci.yml | ||
jobs: | ||
ci: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- run: npm ci | ||
env: | ||
NODE_ENVIRONMENT: development | ||
# ^^ or we don’t get dev-dependencies | ||
- run: npm test | ||
check-generated-dist: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- run: npm ci | ||
env: | ||
NODE_ENVIRONMENT: development | ||
- run: npm run dist | ||
- run: git diff --exit-code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: vx Tagger | ||
on: | ||
release: | ||
types: [published, updated] | ||
jobs: | ||
tag: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: sersoft-gmbh/running-release-tags-action@master | ||
with: | ||
github-token: ${{secrets.GITHUB_TOKEN}} | ||
update-full-release: true | ||
if: github.event.release.prerelease == false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# “Ferret” for Git Things Done | ||
|
||
Fetches comments from old [GitTD][] entries that match a query. | ||
|
||
[GitTD]: https://github.com/git-things-done | ||
|
||
## Purpose | ||
|
||
Essentially a way to keep persistent notes but without the overhead of having | ||
to manage them, with free history. | ||
|
||
For example, I use this to maintain a note about my goals for next year, | ||
fetching the comment titled `# 2022` whenever I want to add to it. Then next | ||
year I can fetch and use the [usher][] to keep it in my daily entry for a few | ||
weeks. | ||
|
||
[usher]: https://github.com/git-things-done/usher | ||
|
||
## Justification | ||
|
||
I plan to use this for occasional notes and lists that I don’t want to “manage” | ||
in a traditional notes app. My notes app is **FULL** at this point. Mostly full | ||
of junk. If I’d used “ferret” instead notes I no longer were interested in would | ||
naturally have been left behind in the ticket history and not clutter the notes | ||
app interface. | ||
|
||
Now I can use my Notes app for important topics and not *everything*. | ||
|
||
# Usage | ||
|
||
Requires [Git Things Done][GitTD]. | ||
|
||
You need a `.github/workflows/ferret.yml`: | ||
|
||
```yaml | ||
name: Ferret | ||
on: | ||
issue_comment: | ||
types: | ||
- created | ||
- edited | ||
jobs: | ||
ferret: | ||
runs-on: ubuntu-latest | ||
if: github.event.issue_comment.user.login != 'github-actions[bot]' | ||
steps: | ||
- uses: git-things-done/ferret@v1 | ||
``` | ||
Then in your daily entry add a new comment: | ||
```markdown | ||
/ferret topic | ||
``` | ||
|
||
The ferret will search do a reverse chronological search for a comment with a | ||
markdown title matching `topic`, if it finds it it will replace the comment | ||
text with what it found. | ||
|
||
[GitTD]: https://github.com/git-things-done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: “Ferret” for Git Things Done | ||
description: > | ||
Fetches comments from old GitTD entries that match a query. | ||
inputs: | ||
token: | ||
default: ${{ github.token }} | ||
runs: | ||
using: node16 | ||
main: dist/index.js | ||
|
||
branding: | ||
icon: check-square | ||
color: green |
Oops, something went wrong.