Skip to content

Commit

Permalink
feat(actions): init commit
Browse files Browse the repository at this point in the history
  • Loading branch information
NeoHsu committed Jul 19, 2022
0 parents commit 0f93a74
Show file tree
Hide file tree
Showing 19 changed files with 2,315 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @neohsu
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug
assignees: neohsu
---
#### Overview of the Issue

A paragraph or two about the issue you're experiencing.

#### Reproduction Steps

Steps to reproduce this issue, eg:

1. Create GitHub action
1. Run actions command `xxxx`
1. View error

### Operating system and Environment details

OS, Architecture, and any other information you can provide about the environment.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Feature Request
about: If you have something you think Consul could improve or add support for.
labels: enhancement
assignees: neohsu
---
#### Feature Description

A written overview of the feature.

#### Use Case(s)

Any relevant use-cases that you see.
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**What's this PR do?**
N/A

**Who must approve?**
N/A

**Any background context you want to provide?**
N/A

**How should this be manually tested?**
N/A

**What are the relevant tickets number link?**
N/A

**Screenshots (if appropriate)**
N/A

**Any dependency (PR, env or any config)?**
N/A

**Anything you want to say:**
N/A
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: docs

on:
push:
paths:
- '**.md'
- '.vuepress'
branches:
- main
workflow_dispatch:
permissions:
actions: write
checks: write
contents: write
pages: write
jobs:
docs:
strategy:
matrix:
os:
- ubuntu-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: "16"
- name: Install dependencies
run: npm install
- name: Build VuePress site
run: npm run docs:build
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v3
with:
target_branch: gh-pages
build_dir: .vuepress/dist
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25 changes: 25 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: lint
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
permissions:
contents: write
pull-requests: write
jobs:
lint:
strategy:
matrix:
os:
- ubuntu-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: github/super-linter/slim@v4
env:
VALIDATE_ALL_CODEBASE: true
VALIDATE_BASH: true
VALIDATE_SHELL_SHFMT: true
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 changes: 22 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: release-please
on:
workflow_dispatch:
push:
branches:
- main
permissions:
actions: read
contents: write
packages: write
pull-requests: write
jobs:
release-please:
strategy:
matrix:
os:
- ubuntu-latest
runs-on: ${{ matrix.os }}
steps:
- uses: google-github-actions/release-please-action@v3
with:
release-type: simple
109 changes: 109 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Vim ###
# Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide

### Windows ###
# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db

# Dump file
*.stackdump

# Folder config file
[Dd]esktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp

# Windows shortcuts
*.lnk

node_modules
.vuepress/.*
.vscode
21 changes: 21 additions & 0 deletions .vuepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { viteBundler } from "@vuepress/bundler-vite";
import { defineUserConfig } from "@vuepress/cli";
import { defaultTheme } from "@vuepress/theme-default";

export default defineUserConfig({
base: "/deploy-files-to-repo/",
locales: {
"/": {
lang: "en-US",
title: "Deploy-Files-to-Repo",
description:
"Deploy-Files-to-Repo is a GitHub action that help to deploy files into other repository & automate created pull request on target repository.",
},
},
bundler: viteBundler(),
pagePatterns: ["*.md"],
theme: defaultTheme({
repoLabel: "GitHub",
repo: "https://github.com/neohsu/deploy-files-to-repo",
}),
});
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing Guidelines

Thank you for your interest in contributing `Deploy-Files-to-Repo` !

Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.

## Become a contributor

Here are some example that you can contribute:

- Contribute to the codebase
- Report and triage bugs
- Write document for user and contributors
- Help others by answering questions
- Help PR review

## Report bugs/feature

Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/neohsu/deploy-files-to-repo/issues) for similar issues.

Report a bug/feature by submitting a [bug ticket](https://github.com/neohsu/deploy-files-to-repo/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.md&title=)/[feature request](https://github.com/neohsu/deploy-files-to-repo/issues/new?assignees=&labels=kind%2Fenhancement&template=feature_request.md&title=). Make sure that you provide as much information as possible on how to reproduce the bug/feature.

Follow the issue template and add additional information that will help us replicate the problem.

## Contributing via Pull Requests

We accept contributions from the community. Contributions via pull requests are much appreciated.

To submit changes:

1. Fork this repository.
2. Create a new feature branch.
3. Make your changes.
4. Submit a pull request with an explanation of your changes or additions.

We will review and work with you to improve it.
52 changes: 52 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Docs & Site

Documentation & site contribution guide.

## Initial Setup

- Fork `Deploy-Files-to-Repo` on GitHub and/or Git clone the default branch:

```shell:no-line-numbers
# clone your forker
git clone https://github.com/<OWNER>/deploy-files-to-repo.git
# or clone asdf
git clone https://github.com/neohsu/deploy-files-to-repo.git
```

- [Node.js](https://nodejs.org): JavaScript runtime built on Chrome's V8 JavaScript engine.

Install Node.js dependencies from `package.json`:

```shell:no-line-numbers
yarn install
```

## Development

[Vuepress (v2)](https://v2.vuepress.vuejs.org/) is the Static Site Generator (SSG) we use to build the `Deploy-Files-to-Repo` documentation site.

`package.json` contains the scripts required for development:

@[code json{7-9}](./package.json)

To start the local development server:

```shell:no-line-numbers
yarn docs:dev
```

Format the code before committing:

```shell:no-line-numbers
yarn docs:format
```

## Pull Requests, Releases & Conventional Commits

Creating a PR for documentation changes please make the PR title with the Conventional Commit type `docs` in the format `docs: <description>`.

## Vuepress

Configuration of the site is contained within a few JavaScript files with JS Objects used to represent the config. They are:

- `.vuepress/config.ts`: the root config file for the site. Read the [Vuepress documentation](https://v2.vuepress.vuejs.org/guide/configuration.html#config-file) for it's spec.
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM alpine/ansible:latest
RUN apk add --no-cache curl git
COPY entrypoint.sh /entrypoint.sh

ENTRYPOINT ["/entrypoint.sh"]
Loading

0 comments on commit 0f93a74

Please sign in to comment.