Skip to content

prepare for release 1.0.0 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Maven Publish
on:
push:
branches:
- 'main'
- 'master'
tags:
- '*'
paths:
Expand Down
4 changes: 4 additions & 0 deletions CHANGLOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 1.0.0 / 2023-02-20

The first release version.

26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Functions Framework for Java

An open source FaaS (Function as a service) framework for writing portable Java functions.

## How to use

A function is typically structured as a Maven project. We recommend using an IDE
that supports Maven to create the Maven project. Add this dependency in the
`pom.xml` file of your project:

```xml
<dependencies>
<dependency>
<groupId>dev.openfunction.functions</groupId>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use io.github.openfunction as group id?
https://www.cnblogs.com/flydean/p/14635788.html
image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use the io.github.openfunction as the group id, everything will be done again, including codes, samples, and publishing.

Using io.github.openfunction instead of dev.openfunction does not provide a noticeable benefit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, openfunction.dev is also our domain name.
That's also ok

<artifactId>functions-framework-api</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
```

If you are using Gradle to build your functions, you can define the Functions
Framework dependency in your `build.gradle` project file as follows:

```groovy
dependencies {
implementation 'dev.openfunction.functions:functions-framework-api:1.0.0'
}
```