https://github.com/kernix13/github-actions-dotfiles

Notes and example for dotfiles and GitHub Actions
https://github.com/kernix13/github-actions-dotfiles

actions dotfiles eslint eslintconfig husky prettier

Last synced: about 1 month ago
JSON representation

Notes and example for dotfiles and GitHub Actions

• Host: GitHub
• URL: https://github.com/kernix13/github-actions-dotfiles
• Owner: Kernix13
• Created: 2022-11-02T21:21:58.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-07T21:08:07.000Z (about 2 years ago)
• Last Synced: 2023-03-05T11:23:33.884Z (almost 2 years ago)
• Topics: actions, dotfiles, eslint, eslintconfig, husky, prettier
• Language: Shell
• Homepage:
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tutorial on GitHub Actions and Dotfiles

[![GitHub Super-Linter](https://github.com/Kernix13/github-actions-dotfiles/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)

My attempt at answering:

1. What are GitHub actions?

1. What are they used for?

1. How do I get them or create them?

1. What are all the dotfiles in GitHub repositories?

1. What are they used for?

1. How and why do I use them?

1. What are boilerplate starter files for each?

I know why to add some of the dotfiles, but I do not know how the other work. I also know that some of the files are creating when you install various NPM packages. 

## Files

I have some sample/template code for each file/folder type

### .github folder

In the root I have `pull_request_template.md`. In `/workflows` I have `build.yml` as an example (DELETED it).

### .husky

I have a `.gitignore` which has what everyone has in it: `_`. Then I have `pre-commit` which also has the same code that everyone has for that file.

### .vscode

I have `settings.json` for a sample from who-knows-where.

### Root folder dotfiles

I have the following:

1. `.editorconfig`: do you need this if you have `.vscode`?

1. `.eslintrc.json`: I've also seen `.eslintignore` but I do not have that file

1. `.prettierignore`: They always seem to have the `build` folder in here but freeCodeCamp has a massive one

1. `.prettierrc.json`: I've also seen this without any extension and with `.js`

### Markdown files

1. `actions.md`: my notes from the videos I watched

1. `dotfiles.md`: notes on the various files

What is **DevOps**?

> DevOps is a set of practices, tools, and a cultural philosophy that automate and integrate the processes between software development and IT teams. It emphasizes team empowerment, cross-team communication and collaboration, and technology automation.

What is a Docker File?

## Contributing

If you found this repo because you were looking into Actions and Dotfiles, and would like to contriute, then open an issue or create a post on t he Discussions tab. I haven't done the license thing for this repo not the other docs (contributing, code-of-conduct).