Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimal CI #53

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Add minimal CI #53

merged 1 commit into from
Oct 28, 2024

Conversation

guizmaii
Copy link
Contributor

Adding:

  • ci.yml file describing the CI process
  • drafter.yml file to enable Release Drafter to automatically maintain the changelog
  • dependabot.yml to automatically maintain the Github Actions definitions

Adding:
- `ci.yml` file describing the CI process
- `drafter.yml` file to enable Release Drafter to automatically maintain the changelog
- `dependabot.yml` to automatically maintain the Github Actions definitions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will dependabot be useful, given that we only have Test and Provided dependencies? I'm not sure I want an alert when the test postgres driver makes a patch release for a vuln.

template: |
# What's Changed

$CHANGES
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is interesting, but where does the draft release notes show up? I've never noticed them on an open source project. I just checked out the ZIO repo (which uses release-drafter), and can't find them either.

I personally don't need it since github now has a 'Generate Release Notes' button. I don't mind the default format. You can remove this for now and we can loop back later.

java-version: 11
check-latest: true
- name: run tests
run: sbt 'clean;test'
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
run: sbt 'clean;test'
run: sbt 'clean; scalafmtCheckAll; test'

steps:
- uses: release-drafter/release-drafter@v6.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need this for now.

@@ -0,0 +1,22 @@
name: CI

on:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add

  push:
    branches: [ "master" ]


on:
pull_request:
types: [ opened, reopened, synchronize ]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
types: [ opened, reopened, synchronize ]
branches: [ "master" ]

Is there a reason to change this from the default Scala configuration (which is just branches: ["master"]?

Comment on lines +7 to +8
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: read

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: coursier/cache-action@v6
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be after setup-java to prevent coursier from installing its own JDK?

The default Scala CI setup on Github does not use coursier/cache-action but instead has

      uses: actions/setup-java@v4
      with:
        java-version: '11'
        distribution: 'temurin'
        cache: 'sbt'

@AugustNagro
Copy link
Owner

Actually, let me just merge and then make the changes, that will be simpler.

@AugustNagro AugustNagro merged commit bcf8ee3 into AugustNagro:master Oct 28, 2024
@guizmaii guizmaii deleted the minimal_ci branch November 15, 2024 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants