Skip to content

Commit

Permalink
various repo structure improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
kMutagene committed Jul 25, 2023
1 parent 2b6617b commit dc6fd13
Show file tree
Hide file tree
Showing 8 changed files with 94 additions and 11 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Build and test

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]


jobs:
build-and-test-linux:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 6.x.x
- name: make script executable
run: chmod u+x build.sh
- name: Build and test
working-directory: ./
run: ./build.sh runtests

build-and-test-windows:

runs-on: windows-latest

steps:
- uses: actions/checkout@v3
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 6.x.x
- name: Build and test
working-directory: ./
run: ./build.cmd runtests
23 changes: 15 additions & 8 deletions FsOboParser.sln
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{A989E8E9-BC2B-4E53-97EC-FE0E9ED342F9}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "build", "build", "{5FA53C60-C472-4A99-A3F7-8098B4606CBE}"
ProjectSection(SolutionItems) = preProject
build.sh = build.sh
build.cmd = build.cmd
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{13CB1D92-20F8-4489-9C1A-F06DDFCF3C37}"
ProjectSection(SolutionItems) = preProject
Expand All @@ -18,24 +22,23 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{13CB
README.md = README.md
EndProjectSection
EndProject
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "build", "build\build.fsproj", "{4A02631E-8D3F-4130-8545-C0B7A7424B90}"
EndProject
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "FsOboParser", "src\FsOboParser\FsOboParser.fsproj", "{9B04A234-E7AC-4960-99A2-3E1B7B05F32A}"
EndProject
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "FsOboParser.Tests", "tests\FsOboParser.Tests\FsOboParser.Tests.fsproj", "{0A4EF63F-C659-4AB6-AF88-CB444A98C434}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{54258338-FD6C-4006-933E-6A71ADC6103D}"
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "build", "build\build.fsproj", "{56A33646-9976-4155-A731-224F688D9F6F}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".ci", ".ci", "{C8635ABF-2029-4D8F-B46D-70D550767EC9}"
ProjectSection(SolutionItems) = preProject
.github\workflows\build-and-test.yml = .github\workflows\build-and-test.yml
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{4A02631E-8D3F-4130-8545-C0B7A7424B90}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{4A02631E-8D3F-4130-8545-C0B7A7424B90}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4A02631E-8D3F-4130-8545-C0B7A7424B90}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4A02631E-8D3F-4130-8545-C0B7A7424B90}.Release|Any CPU.Build.0 = Release|Any CPU
{9B04A234-E7AC-4960-99A2-3E1B7B05F32A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{9B04A234-E7AC-4960-99A2-3E1B7B05F32A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{9B04A234-E7AC-4960-99A2-3E1B7B05F32A}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand All @@ -44,14 +47,18 @@ Global
{0A4EF63F-C659-4AB6-AF88-CB444A98C434}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0A4EF63F-C659-4AB6-AF88-CB444A98C434}.Release|Any CPU.ActiveCfg = Release|Any CPU
{0A4EF63F-C659-4AB6-AF88-CB444A98C434}.Release|Any CPU.Build.0 = Release|Any CPU
{56A33646-9976-4155-A731-224F688D9F6F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{56A33646-9976-4155-A731-224F688D9F6F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{56A33646-9976-4155-A731-224F688D9F6F}.Release|Any CPU.ActiveCfg = Release|Any CPU
{56A33646-9976-4155-A731-224F688D9F6F}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{4A02631E-8D3F-4130-8545-C0B7A7424B90} = {5FA53C60-C472-4A99-A3F7-8098B4606CBE}
{9B04A234-E7AC-4960-99A2-3E1B7B05F32A} = {BC99056C-0431-4FBE-8396-DAB1FFFF2A8F}
{0A4EF63F-C659-4AB6-AF88-CB444A98C434} = {A989E8E9-BC2B-4E53-97EC-FE0E9ED342F9}
{56A33646-9976-4155-A731-224F688D9F6F} = {5FA53C60-C472-4A99-A3F7-8098B4606CBE}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {54B9E6DB-7B93-4B11-AF6D-F46EF21F9781}
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ let myOboOntology = OboOntology.fromFile true filepath

### Create OBO terms

OOP style (adviced):
OOP style (recommended):

```fsharp
let myOboTerm =
Expand Down Expand Up @@ -69,7 +69,7 @@ OboOntology.toFile "myOboOntology.obo" myOntology

### Build (QuickStart)

If not already done, install .NET SDK.
If not already done, install .NET SDK >= 6.

In any shell, run `build.cmd <target>` where `<target>` may be
- if `<target>` is empty, it just runs dotnet build after cleaning everything
Expand Down
25 changes: 25 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
### 0.1.0+2b6617b (Released 2023-7-25)
* Additions:
* [[#2b6617b](https://github.com/CSBiology/FsOboParser/commit/2b6617bb1b8c885a141e80d5718a10dae72ce09e)] Add package metadata
* [[#d7fc8b7](https://github.com/CSBiology/FsOboParser/commit/d7fc8b73e6a184a3ea90c63a42474f570f2ce65c)] Merge pull request #3 from CSBiology/test-testingTheLibrary
* [[#c7cbd18](https://github.com/CSBiology/FsOboParser/commit/c7cbd183aace54370a2c1d8e3b5b198b14b928c4)] Finish Readme (for now)
* [[#5c5caa9](https://github.com/CSBiology/FsOboParser/commit/5c5caa93238f5d5ec49c0ccc9d9e17e4ddb4cfcb)] Add creation function for OBO type def
* [[#e568ff2](https://github.com/CSBiology/FsOboParser/commit/e568ff2dc7949543e2030b8966465f3e676b8909)] Merge pull request #2 from CSBiology/feature-sameName-#1
* [[#989a736](https://github.com/CSBiology/FsOboParser/commit/989a736b593692a79f2b3bbd1ae5b498e66e8339)] Restructure library
* [[#4553f5c](https://github.com/CSBiology/FsOboParser/commit/4553f5cc693970258f6f2742b5f67c0cc63d7585)] Update Readme with Build tutorial
* [[#fbcc358](https://github.com/CSBiology/FsOboParser/commit/fbcc358b040f49b8f8ab60d50dacd1ecf3cfd471)] add build project
* [[#971aa55](https://github.com/CSBiology/FsOboParser/commit/971aa55eb0a527aa4a6b8b8b24facf057dfc1637)] Add test project
* [[#541fb49](https://github.com/CSBiology/FsOboParser/commit/541fb49b35e34bb9b0eaa1f08f4b2fd625d3bc3d)] Copy and split OboParser into parts
* [[#a2e0ca0](https://github.com/CSBiology/FsOboParser/commit/a2e0ca045c11ff3774c438ee04f4ff4d5935d135)] Initial commit
* Deletions:
* [[#3536b6f](https://github.com/CSBiology/FsOboParser/commit/3536b6ff0f6fb1df884e6be912e2b4fc49bc142e)] Delete test method
* Bugfixes:
* [[#e52af5d](https://github.com/CSBiology/FsOboParser/commit/e52af5d351cad07019beb5c19d1f24858518e7d3)] Fix OBO term creation function
* [[#cb179a7](https://github.com/CSBiology/FsOboParser/commit/cb179a7ac919b4d610c1eb75314af47027fce67a)] Update Readme, fix some typos, test functions
* [[#76bbfe8](https://github.com/CSBiology/FsOboParser/commit/76bbfe89b62108d36da5a86130cfa280b79ad865)] Fix some typos, clarify ///-comments
* [[#79e5a43](https://github.com/CSBiology/FsOboParser/commit/79e5a43fb08dc5bac34581428069e6dffc7b8f70)] Fix critical module bug

### 0.0.0 (Released 2023-7-25)
* Additions:
* Initial set up for RELEASE_Notes.md

3 changes: 3 additions & 0 deletions build.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@echo off

dotnet run --project ./build/build.fsproj %*
6 changes: 6 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/env bash

set -eu
set -o pipefail

dotnet run --project ./build/build.fsproj "$@"
3 changes: 3 additions & 0 deletions build/Build.fs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ open TestTasks
open PackageTasks
open DocumentationTasks
open ReleaseTasks
open ReleaseNotesTasks

ReleaseNotesTasks.updateReleaseNotes |> ignore

/// Full release of nuget package, git tag, and documentation for the stable version.
let _release =
Expand Down
2 changes: 1 addition & 1 deletion build/ProjectInfo.fs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ let project = "FsOboParser"

let testProjects =
[
// add relative paths (from project root) to your testprojects here
"tests/FsOboParser.Tests/FsOboParser.Tests.fsproj"
]

let solutionFile = $"{project}.sln"
Expand Down

0 comments on commit dc6fd13

Please sign in to comment.