Release version v0.2.0 (#13)

* ci: add develop workflow (#1)

* refactor: reuse newUser function (#2)

* refactor: reuse newUser function

* ci: fix Fetching the repository

* refactor: move string types to typed package

* refactor: move client to rest package

* refactor: introduce decoder

* refactor: rename types to pagination

* refactor: move back typed to notion package

* fix: linter

* doc: add usage code

* doc: add examples link

* ci: fix error: no such linter "exhaustivestruct"

* Create CODE_OF_CONDUCT.md

* test: add users list/retrive test

* ci: Upload coverage report to codecov (#3)

* doc: add build status and coverage

* test: add search test (#4)

* doc: add go report badge

* doc: fix typo

* test: add databases list/retrieve/query test (#5)

* test: add blocks children list/append test (#6)

* test: HTTPError (#7)

* fix: typo

* test: add pages retrieve/create/update test (#8)

* test: use New() to create SUT (#10)

* test: add settings test (#11)

* ci: add github actions for release process (#12)

Co-authored-by: Pei-Ming Wu <[email protected]>
Co-authored-by: Pei-Ming Wu <[email protected]>

.github/release-drafter.yml

@@ -0,0 +1,23 @@
+name-template: '$RESOLVED_VERSION'
+tag-template: '$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feat'
+      - 'feature'
+      - 'doc'
+      - 'enhancement'
+      - 'test'
+      - 'refactor'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    labels:
+      - 'chore'
+      - 'ci'
+change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+template: |
+  $CHANGES

.github/workflows/develop.yaml

@@ -0,0 +1,39 @@
+name: Lint, Test and Build
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.28.3
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version:
+        - 1.16.x
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v1
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - uses: actions/[email protected]
+
+      - name: Tesing with coverage
+        run: go test -race -coverprofile=coverage.txt -covermode=atomic
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v1
+
+      - name: Build binary
+        run: go build -v

.github/workflows/draft-new-release.yaml

@@ -0,0 +1,37 @@
+name: "Draft new release"
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'The version to release'
+        required: true
+
+jobs:
+  draft-new-release:
+    name: "Draft new release"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Validate the version
+        uses: actions-ecosystem/action-regex-match@v2
+        with:
+          text: ${{ github.event.inputs.version }}
+          regex: '^v\d+(\.\d+){2}$'
+
+      - name: Create release branch
+        run: git checkout -b release/${{ github.event.inputs.version }}
+
+      - name: Push new branch
+        run: git push origin release/${{ github.event.inputs.version }}
+
+      - name: Create pull request
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: release/${{ github.event.inputs.version }}
+          base: main
+          title: Release version ${{ github.event.inputs.version }}
+          reviewers: ${{ github.actor }}

.github/workflows/publish-new-release.yaml

@@ -0,0 +1,40 @@
+name: "Publish new release"
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - closed
+
+jobs:
+  release:
+    name: Publish new release
+    runs-on: ubuntu-latest
+
+    if: github.event.pull_request.merged == true
+
+    steps:
+      - name: Extract version from branch name
+        if: startsWith(github.event.pull_request.head.ref, 'release/')
+        run: |
+          BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+          VERSION=${BRANCH_NAME#release/}
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Validate the version
+        uses: actions-ecosystem/action-regex-match@v2
+        with:
+          text: ${{ env.RELEASE_VERSION }}
+          regex: '^v\d+(\.\d+){2}$'
+
+      - name: Create Release
+        id: generate_changelog
+        uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          version: ${{ env.RELEASE_VERSION }}
+          tag: ${{ env.RELEASE_VERSION }}
+          name: Release ${{ env.RELEASE_VERSION }}
+          publish: false

.golangci.yml

@@ -0,0 +1,29 @@
+# https://github.com/golangci/golangci-lint#config-file
+run:
+  skip-dirs:
+  - pkg/orm
+  - mock_*
+  # build-tags:
+  tests: false
+  deadline: 5m
+  print-resources-usage: true
+
+linters:
+  enable-all: true
+  disable:
+  - godox            # Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false]
+  - gochecknoglobals # Checks that no globals are present in Go code [fast: true, auto-fix: false]
+  - gofumpt
+  - maligned
+  - interfacer
+
+linters-settings:
+  govet:
+    # https://github.com/golangci/golangci-lint/issues/484
+    # report about shadowed variables
+    check-shadowing: false
+  lll:
+    line-length: 150
+  funlen:
+    lines: 70
+    statements: 50

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -1,5 +1,10 @@
 # notion-go
 
+[![Go Report Card](https://goreportcard.com/badge/github.com/mkfsn/notion-go)](https://goreportcard.com/report/github.com/mkfsn/notion-go)
+[![Actions Status](https://github.com/mkfsn/notion-go/actions/workflows/develop.yaml/badge.svg)](https://github.com/mkfsn/notion-go/actions)
+[![codecov](https://codecov.io/gh/mkfsn/notion-go/branch/develop/graph/badge.svg?token=NA64P6EPQ0)](https://codecov.io/gh/mkfsn/notion-go)
+
+
 A go client for the [Notion API](https://developers.notion.com/)
 
 ## Description
@@ -13,6 +18,47 @@ which is written in JavaScript.
 go get -u github.com/mkfsn/notion-go
 ```
 
+## Usage
+
+```go
+c := notion.New("<NOTION_AUTH_TOKEN>")
+
+// Retrieve block children
+c.Blocks().Children().List(...)
+
+// Append block children
+c.Blocks().Children().Append(...)
+
+// List databases
+c.Databases().List(...)
+
+// Query a database
+c.Databases().Query(...)
+
+// Retrieve a database
+c.Databases().Retrieve(...)
+
+// Create a page
+c.Pages().Create(...)
+
+// Retrieve a page
+c.Pages().Retreive(...)
+
+// Update page properties
+c.Pages().Update(...)
+
+// List all users
+c.Users().List(...)
+
+// Retrieve a user
+c.Users().Retrieve(...)
+
+// Search
+c.Search(...)
+```
+
+For more information, please see [examples](./examples).
+
 ## Supported Features
 
 This client supports all endpoints in the [Notion API](https://developers.notion.com/reference/intro).