Git Product home page Git Product logo

.github's People

Contributors

xrkffgg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

.github's Issues

Interested in contributing GitHub wiki-related actions

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.