Skip to content

Commit

Permalink
Add github workflows & templates
Browse files Browse the repository at this point in the history
  • Loading branch information
thecoolwinter committed Dec 12, 2023
1 parent 151dfcd commit d33f35f
Show file tree
Hide file tree
Showing 13 changed files with 281 additions and 0 deletions.
Binary file added .github/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 🐞 Bug report
description: Something is not working as expected.
title: 🐞 <bug title>
labels: bug

body:
- type: textarea
attributes:
label: Description
placeholder: >-
A clear and concise description of what the bug is...
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: >-
Steps to reliably reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
placeholder: >-
A clear and concise description of what you expected to happen...
validations:
required: true

- type: textarea
attributes:
label: Version Information
description: >-
click on the version number on the welcome screen
value: |
CodeEditTextView: [e.g. 0.x.y]
macOS: [e.g. 13.2.1]
Xcode: [e.g. 14.2]
- type: textarea
attributes:
label: Additional Context
placeholder: >-
Any other context or considerations about the bug...
- type: textarea
attributes:
label: Screenshots
placeholder: >-
If applicable, please provide relevant screenshots or screen recordings...
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: ✨ Feature request
description: Suggest an idea for this project
title: ✨ <feature title>
labels: enhancement

body:
- type: textarea
attributes:
label: Description
placeholder: >-
A clear and concise description of what you would like to happen...
validations:
required: true

- type: textarea
attributes:
label: Alternatives Considered
placeholder: >-
Any alternative solutions or features you've considered...
- type: textarea
attributes:
label: Additional Context
placeholder: >-
Any other context or considerations about the feature request...
- type: textarea
attributes:
label: Screenshots
placeholder: >-
If applicable, please provide relevant screenshots or screen recordings...
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--- IMPORTANT: If this PR addresses multiple unrelated issues, it will be closed until separated. -->

### Description

<!--- REQUIRED: Describe what changed in detail -->

### Related Issues

<!--- REQUIRED: Tag all related issues (e.g. * #123) -->
<!--- If this PR resolves the issue please specify (e.g. * closes #123) -->
<!--- If this PR addresses multiple issues, these issues must be related to one other -->

* #ISSUE_NUMBER

### Checklist

<!--- Add things that are not yet implemented above -->

- [ ] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md)
- [ ] The issues this PR addresses are related to each other
- [ ] My changes generate no new warnings
- [ ] My code builds and runs on my machine
- [ ] My changes are all related to the related issue above
- [ ] I documented my code

### Screenshots

<!--- REQUIRED: if issue is UI related -->

<!--- IMPORTANT: Fill out all required fields. Otherwise we might close this PR temporarily -->
8 changes: 8 additions & 0 deletions .github/scripts/build-docc.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash

export LC_CTYPE=en_US.UTF-8

set -o pipefail && xcodebuild clean docbuild -scheme CodeEditTextView \
-destination generic/platform=macos \
-skipPackagePluginValidation \
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path CodeEditTextView --output-path ./docs" | xcpretty
21 changes: 21 additions & 0 deletions .github/scripts/tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#!/bin/bash

ARCH=""

if [ $1 = "arm" ]
then
ARCH="arm64"
else
ARCH="x86_64"
fi

echo "Building with arch: ${ARCH}"

export LC_CTYPE=en_US.UTF-8

set -o pipefail && arch -"${ARCH}" xcodebuild \
-scheme CodeEditTextView \
-derivedDataPath ".build" \
-destination "platform=macos,arch=${ARCH}" \
-skipPackagePluginValidation \
clean test | xcpretty
16 changes: 16 additions & 0 deletions .github/workflows/CI-pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: CI - Pull Request
on:
pull_request:
branches:
- 'main'
workflow_dispatch:
jobs:
swiftlint:
name: SwiftLint
uses: ./.github/workflows/swiftlint.yml
secrets: inherit
test:
name: Testing CodeEditTextView
needs: swiftlint
uses: ./.github/workflows/tests.yml
secrets: inherit
21 changes: 21 additions & 0 deletions .github/workflows/CI-push.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: CI - Push to main
on:
push:
branches:
- 'main'
workflow_dispatch:
jobs:
swiftlint:
name: SwiftLint
uses: ./.github/workflows/swiftlint.yml
secrets: inherit
test:
name: Testing CodeEditTextView
needs: swiftlint
uses: ./.github/workflows/tests.yml
secrets: inherit
build_documentation:
name: Build Documentation
needs: [swiftlint, test]
uses: ./.github/workflows/build-documentation.yml
secrets: inherit
20 changes: 20 additions & 0 deletions .github/workflows/add-to-project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Add new issues to project

on:
issues:
types:
- opened

jobs:
add-to-project:
name: Add new issues labeled with enhancement or bug to project
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
# You can target a repository in a different organization
# to the issue
project-url: https://github.com/orgs/CodeEditApp/projects/3
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
labeled: enhancement, bug
label-operator: OR
54 changes: 54 additions & 0 deletions .github/workflows/build-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: build-documentation
on:
workflow_dispatch:
workflow_call:
jobs:
build-docc:
runs-on: [self-hosted, macOS]
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Build Documentation
run: exec ./.github/scripts/build-docc.sh
- name: Init new repo in dist folder and commit generated files
run: |
cd docs
git init
git add -A
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git commit -m 'deploy'
- name: Force push to destination branch
uses: ad-m/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: docs
force: true
directory: ./docs

############################
##### IMPORTANT NOTICE #####
############################
# This was used to build the documentation catalog until
# it didn't produce the 'documentation' directory anymore.
#
# - uses: fwcd/[email protected]
# with:
# target: CodeEditTextView
# output: ./docs
# hosting-base-path: CodeEditTextView
# disable-indexing: 'true'
# transform-for-static-hosting: 'true'
#
# The command that this plugin uses is:
#
# swift package --allow-writing-to-directory ./docs generate-documentation \
# --target CodeEditTextView
# --output-path ./docs
# --hosting-base-path CodeEditTextView
# --disable-indexing
# --transform-for-static-hosting
#
# We now use xcodebuild to build the documentation catalog instead.
#
11 changes: 11 additions & 0 deletions .github/workflows/swiftlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: SwiftLint
on:
workflow_dispatch:
workflow_call:
jobs:
SwiftLint:
runs-on: [self-hosted, macOS]
steps:
- uses: actions/checkout@v3
- name: GitHub Action for SwiftLint with --strict
run: swiftlint --strict
13 changes: 13 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: tests
on:
workflow_dispatch:
workflow_call:
jobs:
code-edit-text-view-tests:
name: Testing CodeEditTextView
runs-on: [self-hosted, macOS]
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Testing Package
run: exec ./.github/scripts/tests.sh arm

0 comments on commit d33f35f

Please sign in to comment.