Root directory content refactoring (#1725)

* Root directory refactoring: - move info about Bootup Logo from a sepatate README to main README; - replace separate root scripts build.sh and start_dev.sh by root Makefile; - make Scripts directory and move there: flash_ts100_linux.sh script, ci/ directory, dockerfile, LICENSE_RELEASE, and PULL_REQUEST_TEMPLATE; - reconfigure build & deploy scripts according to changes

* Scripts => scripts

* Scripts -> scripts: re-add missing renamed files

* Directories refactoring: add top-level Makefile, add scripts/deploy.sh script, move github templates from top-level dir to .github, organize files inside Development Resources

* Update scripts/deploy.sh accroding to codestyle syntax shellcheck

* Makefile: add docs-deploy target for mkdocs gh-deploy

* Rename IronOS.yml > Env.yml, update related files

* Docs configs: remove empty characters

* docs/devel: update usage of new script
This commit is contained in:
Ivan Zorin
2023-07-02 04:32:40 +03:00
committed by GitHub
parent 990f42ad1a
commit b524a99ff2
27 changed files with 235 additions and 24 deletions

18
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,18 @@
<!-- Please try and fill out this template where possible, not all fields are required and can be removed. -->
* **Please check if the PR fulfills these requirements**
- [] The changes have been tested locally
- [] There are no breaking changes
* **What kind of change does this PR introduce?**
<!-- (Bug fix, feature, docs update, ...) -->
* **What is the current behavior?**
<!-- (You can also just link to an open issue here) -->
* **What is the new behavior (if this is a feature change)?**
* **Other information**:

18
.github/security.md vendored Normal file
View File

@@ -0,0 +1,18 @@
# Security Policy
## Supported Versions
Use this section to tell people about which versions of your project are
currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| Latest Release | :white_check_mark: |
| master | :white_check_mark: |
## Reporting a Vulnerability
1. Report in an issue please and tag @ralim
2. All issues are read within 1 working week in general; often within 24 hours
3. Issue shall recieve a comment within 14 days; but goal is < 2.
4. Issue will be open until the vulnerability is closed in all supported versions

View File

@@ -35,6 +35,6 @@ jobs:
mkdocs-git-revision-date-plugin mkdocs-autolinks-plugin \
mkdocs-awesome-pages-plugin
- run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
- name: Publish docs
run: mkdocs gh-deploy
run: mkdocs gh-deploy -f scripts/IronOS-mkdocs.yml -d ../site

View File

@@ -32,7 +32,7 @@ jobs:
- name: copy license text
run: |
cp LICENSE source/Hexfile/LICENSE
cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
cp scripts/LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
- name: Archive ${{ matrix.model }} artifacts
uses: actions/upload-artifact@v3
@@ -83,7 +83,7 @@ jobs:
- name: copy license text
run: |
cp LICENSE source/Hexfile/LICENSE
cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
cp scripts/LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
- name: Archive ${{ matrix.model }} artifacts
uses: actions/upload-artifact@v3