Skip to content

Commit

Permalink
Replace template placeholders with project info
Browse files Browse the repository at this point in the history
As described; the `go-template` was replaced with some basic
placeholders for actual project information. This is not a complete
implementation.
  • Loading branch information
bitwizeshift committed Jun 27, 2024
1 parent 2f8d65a commit e9b8095
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 152 deletions.
11 changes: 0 additions & 11 deletions .github/workflows/postsubmit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,11 @@ jobs:
contents: read
id-token: write

snapshot-release:
name: Snapshot Release
uses: friendly-fhir/.github/.github/workflows/go-release.yaml@master
with:
snapshot: true
permissions:
contents: write
attestations: write
id-token: write

email-on-failure:
name: Email on Failure
runs-on: ubuntu-latest
needs:
- build-and-test
- snapshot-release
if: always() && failure()
continue-on-error: true
steps:
Expand Down
34 changes: 0 additions & 34 deletions .github/workflows/release.yaml

This file was deleted.

70 changes: 0 additions & 70 deletions .goreleaser.yaml

This file was deleted.

28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
# Go Project Template

![Continuous Integration](https://img.shields.io/github/actions/workflow/status/friendly-fhir/go-template/.github%2Fworkflows%2Fpostsubmit.yaml?logo=github)
[![GitHub Release](https://img.shields.io/github/v/release/friendly-fhir/go-template?include_prereleases)][github-releases]
![Continuous Integration](https://img.shields.io/github/actions/workflow/status/friendly-fhir/go-fhirpath/.github%2Fworkflows%2Fpostsubmit.yaml?logo=github)
[![GitHub Release](https://img.shields.io/github/v/release/friendly-fhir/go-fhirpath?include_prereleases)][github-releases]
[![Gitter Channel](https://img.shields.io/badge/matrix-%23friendly--fhir-darkcyan?logo=gitter)][gitter-channel]
[![readthedocs](https://img.shields.io/badge/docs-readthedocs-blue?logo=readthedocs&logoColor=white)][docs]
[![Godocs](https://img.shields.io/badge/docs-godocs-blue?logo=go&logoColor=white)][go-docs]

This is a GitHub Repository Template for Go projects in the Friendly FHIR org!
An implementation of the [FHIRPath] query language in Go.

Make sure to follow this handy guide when using this as a template for new
projects. Most of this has been done for you, but there are a few things you
should update when starting a new project.
This is made with the [go-fhir] library.

[gitter-channel]: https://matrix.to/#/#go-template:gitter.im
[docs]: https://friendly-fhir.github.io/go-template/
[go-docs]: https://pkg.go.dev/github.com/friendly-fhir/go-template
[github-releases]: https://github.com/friendly-fhir/go-template/releases
[FHIRPath]: https://www.hl7.org/fhirpath/
[go-fhir]: https://github.com/friendly-fhir/go-fhir

## Steps
[gitter-channel]: https://matrix.to/#/#go-fhirpath:gitter.im
[docs]: https://friendly-fhir.github.io/go-fhirpath/
[go-docs]: https://pkg.go.dev/github.com/friendly-fhir/go-fhirpath
[github-releases]: https://github.com/friendly-fhir/go-fhirpath/releases

* [ ] Update the `go.mod` file with the correct module name
* [ ] Replace `main.go` with your project's main file or library entry point
* [ ] Replace `go-template` with your repository's name in links
* [ ] Replace references to `go-template` with your project name in `docs/` and
`mkdocs.yaml`
* [ ] Update the `README.md` file with the correct project name and description,
and remove these docs.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Go Template
# FHIRPath Go

> **NOTE:** This is the default docs for the Go Template.
> **NOTE:** This is the default docs for the FHIRPath Go.
> Replace this with your own documentation.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/friendly-fhir/go-template
module github.com/friendly-fhir/go-fhirpath

go 1.22.3

Expand Down
2 changes: 1 addition & 1 deletion internal/greeting/greeting_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package greeting_test
import (
"testing"

"github.com/friendly-fhir/go-template/internal/greeting"
"github.com/friendly-fhir/go-fhirpath/internal/greeting"
"github.com/google/go-cmp/cmp"
)

Expand Down
11 changes: 0 additions & 11 deletions main.go

This file was deleted.

8 changes: 4 additions & 4 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# yaml-language-server: $schema=https://json.schemastore.org/mkdocs-1.0.json
site_name: Go Template
site_name: FHIRPath Go
copyright: Friendly FHIR Contributors 2024
repo_name: go-template
repo_url: https://github.com/friendly-fhir/go-template
repo_name: go-fhirpath
repo_url: https://github.com/friendly-fhir/go-fhirpath
remote_branch: origin/master
remote_name: origin
site_author: Matthew Rodusek
site_description: The Friendly FHIR organization
site_url: https://friendly-fhir.github.io/go-template
site_url: https://friendly-fhir.github.io/go-fhirpath
site_dir: dist
docs_dir: docs

Expand Down

0 comments on commit e9b8095

Please sign in to comment.