Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bitPogo committed Sep 16, 2021
1 parent 407ee44 commit ba500d7
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 5 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
= Changelog
:link-repository: https://github.com/d4l-data4life/hc-fhir-sdk-java
:doctype: article
:toc: macro
:toclevels: 1
:toc-title:
:icons: font
:imagesdir: assets/images
ifdef::env-github[]
:warning-caption: :warning:
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
endif::[]

All notable changes to this project will be documented in this file.

Expand All @@ -18,12 +29,18 @@ toc::[]

=== Changed

=== Deprecated

=== Removed

=== Fixed

=== Security

=== Bumped

=== Deprecated

=== Migration

== https://github.com/d4l-data4life/hc-fhir-sdk-java/compare/v1.6.2...v1.6.3[1.6.3]
Expand Down
6 changes: 5 additions & 1 deletion Dangerfile.df.kts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ danger(args) {
"(?:release\\/(?:\\d{1,3}\\.\\d{1,3}(?:\\.\\d{1,3})?)(?:\\/prepare-\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})?)"
.toRegex()
.matches(branchName)
val isDependabotBranch =
"dependabot/(.*)"
.toRegex()
.matches(branchName)
val isFeatureTitle =
"(?:(?:\\[[A-Z]{2,8}-\\d{1,6}\\]\\s)?(?:Add|Change|Remove|Fix|Bump|Security)\\s.*)"
.toRegex()
Expand All @@ -42,7 +46,7 @@ danger(args) {
.matches(pullRequest.title)


if (!isFeatureBranch && !isReleaseBranch) {
if (!isFeatureBranch && !isReleaseBranch && !isDependabotBranch) {
fail(
"Branch name is not following our pattern:\n" +
"\nrelease/1.2(.3)(/prepare-1.2.3)\n" +
Expand Down
14 changes: 14 additions & 0 deletions MIGRATION.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
= Migration guide
:link-repository: https://github.com/d4l-data4life/hc-fhir-sdk-java
:doctype: article
:toc: macro
:toclevels: 1
:toc-title:
:icons: font
:imagesdir: assets/images
ifdef::env-github[]
:warning-caption: :warning:
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
endif::[]

This file will contain information to help you migrate from one version
to another.
Expand Down
12 changes: 8 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= Data4life FHIR SDK for Android/Java
:library_version: 1.6.2
:link-repository: https://github.com/d4l-data4life/hc-fhir-sdk-java
:toc: macro
:toclevels: 2
:toc-title:
Expand All @@ -23,12 +25,14 @@ endif::[]
<div align="center">
<!-- PROJECT LOGO -->
<p>
<a><img src="https://github.com/d4l-data4life/hc-fhir-sdk-java/blob/main/assets/images/d4l-logo.svg" width="150"/></a>
<a href="https://github.com/d4l-data4life/hc-fhir-sdk-java">
<img src="assets/images/d4l-logo.svg" width="150"/>
</a>
</p>
<!-- PROJECT HEADER -->
<h1>data4life FHIR STU3 for Android/Java</h1>
<h1>Data4life FHIR SDK for Android/Java</h1>
<p><!-- PROJECT DESCRIPTION -->
Minimal FHIR standard models and data types for Android and Java
Minimal FHIR standard models and data types of STU3 and R4 for Android and Java
</p>
<p><!-- PROJECT DOCUMENTATION -->
<a href="https://github.com/d4l-data4life/hc-fhir-sdk-java"><strong>Explore the docs »</strong></a>
Expand All @@ -40,7 +44,7 @@ endif::[]
</p>
<p><!-- PROJECT BADGES -->
<a href="https://github.com/d4l-data4life/hc-fhir-sdk-java/actions">
<img src="https://github.com/d4l-data4life/hc-fhir-sdk-java/workflows/D4L%20CI/badge.svg" alt="Build Status"/>
<img src="https://github.com/d4l-data4life/hc-fhir-sdk-java/workflows/D4L%20CI/badge.svg" alt="D4L CI - Latest Version"/>
</a>
<a href="https://github.com/d4l-data4life/hc-fhir-sdk-java/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-PRIVATE-blue.svg"/>
Expand Down

0 comments on commit ba500d7

Please sign in to comment.