Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Interested in contributing GitHub wiki-related actions #2

Open
jcbhmr opened this issue Jul 17, 2023 · 1 comment
Open

Interested in contributing GitHub wiki-related actions #2

jcbhmr opened this issue Jul 17, 2023 · 1 comment

Comments

@jcbhmr
Copy link

jcbhmr commented Jul 17, 2023

Hello! 👋

I'm "shopping" around for cool GitHub Actions organizations so that my actions aren't stuck if I loose interest in it or am not active or whatever. IDK if this organization wants new projects? Sorry if I'm in the wrong spot here.

I am interested in adding GitHub Actions that would make it easy to sync a GitHub in-source folder like /wiki/*.md to the actual "wiki" tab on GitHub. This is useful for users who want to possibly:

  • Autogenerate documentation but don't want to put it on GitHub Pages, so they put it on a wiki instead
  • Allowing the normal GitHub flow of PRs + merges for wiki changes
  • Letting users auto-generate other things like build data and post it to the wiki
  • etc.

Particularily, there are 4 "things" that I see being useful to have actions for so that you can do something like this:

on:
  push:
    branches: "main"
    paths: wiki/**
jobs:
  source-to-wiki:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-cool/source-to-wiki-links@v1
      - uses: actions-cool/upload-wiki@v1
on:
  gollum: null
  schedule:
    - cron: "0 0 * * *"
jobs:
  wiki-to-source:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-cool/download-wiki@v1
      - uses: actions-cool/wiki-to-source-links@v1
      - uses: EndBug/add-and-commit@v9

Here's my ideas for the 4 composable actions:

  • action-source-to-wiki-links: Rewrites links like ./Hello.md to be ./Hello since GitHub wikis don't do file extensions; also renames README.md to Home.md
  • action-(publish|push|upload)-wiki: Pushes current folder or subfolder to the GitHub wiki
  • action-(download|clone|pull)-wiki: Pulls the GitHub wiki to the current folder or sub folder
  • action-wiki-to-source-links: Rewrites links like ./Hello to ./Hello.(md|markdown|mdown,etc) to work in source control; also renames Home.md to README.md
@jcbhmr
Copy link
Author

jcbhmr commented Jul 17, 2023

So far, I've got 2/4 repos ready to just hit transfer on that are "working"!
https://github.com/jcbhmr/preprocess-source-for-github-wiki
https://github.com/jcbhmr/preprocess-github-wiki-for-source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant