Skip to content

Commit

Permalink
Merge pull request #49 from pmonks/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
pmonks committed Feb 13, 2024
2 parents 2f4581a + c441b9f commit 0a03ecd
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 20 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: 17
- uses: DeLaGuardo/setup-clojure@12.1
java-version: 21
- uses: DeLaGuardo/setup-clojure@12.5
with:
cli: latest
- uses: actions/cache@v3
- uses: actions/cache@v4
with:
path: |
~/.m2/repository
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Build stage
FROM clojure:temurin-21-tools-deps-jammy as build-stage
FROM clojure:temurin-21-tools-deps as build-stage
ENV APP_DIR /opt/for-science
WORKDIR $APP_DIR
COPY . $APP_DIR
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.spdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SPDXVersion: SPDX-2.1
SPDXVersion: SPDX-2.3
DataLicense: CC0-1.0
Creator: Peter Monks
PackageName: com.github.pmonks/for-science
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
| | | |
|---:|:---:|:---:|
| [**main**](https://github.com/pmonks/for-science/tree/main) | [![CI](https://github.com/pmonks/for-science/workflows/CI/badge.svg?branch=main)](https://github.com/pmonks/for-science/actions?query=workflow%3ACI+branch%3Amain) | [![Dependencies](https://github.com/pmonks/for-science/workflows/dependencies/badge.svg?branch=main)](https://github.com/pmonks/for-science/actions?query=workflow%3Adependencies+branch%3Amain) |
| [**release**](https://github.com/pmonks/for-science/tree/release) | [![CI](https://github.com/pmonks/for-science/workflows/CI/badge.svg?branch=release)](https://github.com/pmonks/for-science/actions?query=workflow%3ACI+branch%3Arelease) | [![Dependencies](https://github.com/pmonks/for-science/workflows/dependencies/badge.svg?branch=release)](https://github.com/pmonks/for-science/actions?query=workflow%3Adependencies+branch%3Arelease) |
| [**dev**](https://github.com/pmonks/for-science/tree/dev) | [![CI](https://github.com/pmonks/for-science/workflows/CI/badge.svg?branch=dev)](https://github.com/pmonks/for-science/actions?query=workflow%3ACI+branch%3Adev) | [![Dependencies](https://github.com/pmonks/for-science/workflows/dependencies/badge.svg?branch=dev)](https://github.com/pmonks/for-science/actions?query=workflow%3Adependencies+branch%3Adev) |

[![Open Issues](https://img.shields.io/github/issues/pmonks/for-science.svg)](https://github.com/pmonks/for-science/issues)
[![License](https://img.shields.io/github/license/pmonks/for-science.svg)](https://github.com/pmonks/for-science/blob/main/LICENSE)
[![License](https://img.shields.io/github/license/pmonks/for-science.svg)](https://github.com/pmonks/for-science/blob/release/LICENSE)

# for-science

A small [Discord](https://discord.com/) bot that you can send Clojure code to, to experiment with the language, demonstrate core language principles, or just mess about. Note: only supports the subset of Clojure's core provided by the [Small Clojure Interpreter](https://github.com/borkdude/sci).

Please review the [privacy policy](https://github.com/pmonks/for-science/blob/main/PRIVACY.md) before interacting with the bot.
Please review the [privacy policy](https://github.com/pmonks/for-science/blob/release/PRIVACY.md) before interacting with the bot.

## Adding the Bot to Your Discord Server

Expand Down Expand Up @@ -38,22 +38,22 @@ Currently the bot is only distributed in source form, so regardless of how you i

#### Direct Execution

1. Either set environment variables as described in the default [`config.edn` file](https://github.com/pmonks/for-science/blob/main/resources/config.edn), or copy that file somewhere else and hardcode the values in the file directly.
1. Either set environment variables as described in the default [`config.edn` file](https://github.com/pmonks/for-science/blob/release/resources/config.edn), or copy that file somewhere else and hardcode the values in the file directly.
2. If you set the environment variables in the previous step run `clj -M:run`, otherwise run `clj -M:run -c /path/to/your/config.edn`

## Contributor Information

[Contributing Guidelines](https://github.com/pmonks/for-science/blob/main/.github/CONTRIBUTING.md)
[Contributing Guidelines](https://github.com/pmonks/for-science/blob/release/.github/CONTRIBUTING.md)

[Bug Tracker](https://github.com/pmonks/for-science/issues)

[Code of Conduct](https://github.com/pmonks/for-science/blob/main/.github/CODE_OF_CONDUCT.md)
[Code of Conduct](https://github.com/pmonks/for-science/blob/release/.github/CODE_OF_CONDUCT.md)

### Developer Workflow

This project uses the [git-flow branching strategy](https://nvie.com/posts/a-successful-git-branching-model/), with the caveat that the permanent branches are called `main` and `dev`, and any changes to the `main` branch are considered a release and auto-deployed (push to Heroku).
This project uses the [git-flow branching strategy](https://nvie.com/posts/a-successful-git-branching-model/), and the permanent branches are called `release` and `dev`, and any changes to the `release` branch are considered a release and auto-deployed (to Digital Ocean).

For this reason, **all development must occur either in branch `dev`, or (preferably) in temporary branches off of `dev`.** All PRs from forked repos must also be submitted against `dev`; the `main` branch is **only** updated from `dev` via PRs created by the core development team. All other changes submitted to `main` will be rejected.
For this reason, **all development must occur either in branch `dev`, or (preferably) in temporary branches off of `dev`.** All PRs from forked repos must also be submitted against `dev`; the `release` branch is **only** updated from `dev` via PRs created by the core development team. All other changes submitted to `release` will be rejected.

## License

Expand Down
4 changes: 2 additions & 2 deletions deps.edn
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
{:paths ["src" "resources"]
:deps
{org.clojure/clojure {:mvn/version "1.11.1"}
org.babashka/sci {:mvn/version "0.8.40"}
com.github.pmonks/discljord-utils {:mvn/version "1.0.91"}}
org.babashka/sci {:mvn/version "0.8.41"}
com.github.pmonks/discljord-utils {:mvn/version "1.0.126"}}
:aliases
{:build {:deps {com.github.pmonks/pbr {:mvn/version "RELEASE"}}
:ns-default pbr.build}
Expand Down
3 changes: 2 additions & 1 deletion pbr.clj
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@
(assoc opts
:lib 'org.github.pmonks/for-science
:version (format "1.0.%s" (.format (java.text.SimpleDateFormat. "yyyyMMdd") (java.util.Date.)))
:prod-branch "release"
:uber-file "./target/for-science-standalone.jar"
:main 'bot.main
:deploy-info-file "./resources/build-info.edn"
:write-pom true
:pom {:description "A small Discord bot that you can send Clojure code to, to experiment with the language, demonstrate core language principles, or just mess about."
:url "https://github.com/pmonks/for-science"
:licenses [:license {:name "Apache License 2.0" :url "http://www.apache.org/licenses/LICENSE-2.0.html"}]
:licenses [:license {:name "Apache-2.0" :url "http://www.apache.org/licenses/LICENSE-2.0.html"}]
:developers [:developer {:id "pmonks" :name "Peter Monks" :email "pmonks+forscience@gmail.com"}]
:scm {:url "https://github.com/pmonks/for-science" :connection "scm:git:git://github.com/pmonks/for-science.git" :developer-connection "scm:git:ssh://git@github.com/pmonks/for-science.git"}
:issue-management {:system "github" :url "https://github.com/pmonks/for-science/issues"}}))
6 changes: 3 additions & 3 deletions resources/build-info.edn
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{:hash "7e639dd2a5675d7e911aba2356d8024f90b2c24b",
:date #inst "2023-10-23T18:05:17.983-00:00",
{:hash "1f390c802b7b1c3d6c71bbc8da3ef3880da15958",
:date #inst "2024-02-13T22:53:02.099-00:00",
:repo "https://github.com/pmonks/for-science.git",
:tag "1.0.20231023"}
:tag "1.0.20240213"}

0 comments on commit 0a03ecd

Please sign in to comment.