欢迎访问shiker.tech

请允许在我们的网站上展示广告

您似乎使用了广告拦截器,请关闭广告拦截器。我们的网站依靠广告获取资金。

开源项目如何管理
(last modified Mar 31, 2024, 8:56 PM )
by
侧边栏壁纸
  • 累计撰写 176 篇文章
  • 累计创建 61 个标签
  • 累计收到 4 条评论

目 录CONTENT

文章目录

开源项目如何管理

橙序员
2024-03-31 / 0 评论 / 0 点赞 / 145 阅读 / 1,904 字 / 正在检测百度是否收录... 正在检测必应是否收录...
文章摘要(AI生成)

社区标准项目描述、自述、开源协议选取和配置、以及其他社区配置项目的安全Git action编译验证打包发布等内容进行了详细介绍。项目描述和自述是非常重要的,需要清晰描述项目的用途和背景。在选择和配置开源协议时,可以参考流行的许可证如MIT、Apache 2.0和GPLv3,也可以根据社区偏好选择合适的许可证。另外,还介绍了其他社区配置文件如CODE_OF_CONDUCT.md、CONTRIBUTING.md等,这些文件定义了社区的行为准则和贡献方式,有助于维护社区秩序和吸引贡献者。总体而言,项目的规范化和标准化对于项目的发展和社区建设至关重要。

社区标准

社区标准设置在项目的insights选项中进行配置:

image-20240331193259882

项目描述和自述

项目的描述和自述是非常需要的,项目描述通常需要描述需要一句话介绍项目的用途。例如:

image-20240331193438072

而readme文档一般需要介绍项目的背景、目的以及使用说明。

开源协议选取和配置

配置步骤见:添加许可到仓库

开源协议流行度:

image-20240331192139733

MITApache 2.0GPLv3流行的开源许可证,但还有其他选项可供选择。您可以在Choosealicense.com上找到这些许可证的全文以及如何使用它们的说明。

根据原始项目的许可证,可能需要使用相同的许可证,而不仅仅是最简单的事情。 (请参阅某些许可证的“相同许可证”条件。)

一些社区对特定许可证有强烈的偏好。如果您想参与其中之一,即使您正在启动一个没有现有依赖项的全新项目,使用他们的首选许可证也会更容易。一些例子包括:

MIT:简短而简单的许可许可,其条件仅要求保留版权和许可通知。许可作品、修改版和大型作品可以根据不同的条款进行分发,并且无需源代码。

image-20240331192449208)

GNU GPLv3: 允许人们用你的项目做任何他们想做的事情,除了发布闭源版本。

其他社区配置

Community health file Description
CODE_OF_CONDUCT.md CODE_OF_CONDUCT 文件定义如何参与社区的标准。有关详细信息,请参阅“向项目添加行为准则”。
CONTRIBUTING.md 贡献文件传达人们应如何为您的项目做出贡献。有关详细信息,请参阅“为存储库贡献者设置指南”。
Discussion category forms 讨论类别表单自定义模板,供社区成员在存储库中打开新讨论时使用。有关详细信息,请参阅“创建讨论类别表单”。
FUNDING.yml FUNDING 文件会在您的存储库中显示赞助商按钮,以提高开源项目的资助选项的可见性。有关详细信息,请参阅“在存储库中显示赞助商按钮”。
GOVERNANCE.md 治理文件可以让人们了解您的项目是如何治理的。例如,它可能会讨论项目角色以及如何制定决策。
issue和拉取请求模板和config.yml 问题和拉取请求模板可自定义和标准化您希望贡献者在存储库中打开问题和拉取请求时包含的信息。有关详细信息,请参阅“关于问题和拉取请求模板”。
SECURITY.md SECURITY 文件提供有关如何报告项目中的安全漏洞的说明。有关详细信息,请参阅“向存储库添加安全策略”。
SUPPORT.md 支持文件可让人们了解获得项目帮助的方法。有关详细信息,请参阅“向您的项目添加支持资源”。

项目安全

image-20240331193623228

项目安全包括安全策略、漏洞报告、安全检测、依赖检测,代码扫描,密钥扫描等

这里我们需要配置安全策略,代码扫描和依赖扫描。需要在项目的Code security and analysis选项中进行设置

默认配置好依赖规则和Code ql后项目即可完成设置,进行初始的代码扫描:

image-20240331203925112

Git action

git action提供了很多项目工作流,提供了便于我们进行分支编译验证,代码发布管理等功能。

编译验证

如果是java项目,那么根据我们使用的仓库工具maven、gradle,可以有相应的maven build ci和gradle build ci可供选择:

image-20240331204236301

image-20240331204214325

以gradle为例,我们可以选择对应配置并修改配置文件进行代码编译:

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle

name: Java CI with Gradle

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:
  build:

    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
    - uses: actions/checkout@v4
    - name: Set up JDK 17
      uses: actions/setup-java@v4
      with:
        java-version: '17'
        distribution: 'temurin'

    # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies.
    # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
    - name: Setup Gradle
      uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
    - name: Grant execute permission to Gradle wrapper
      run: chmod +x ./gradlew  # 添加执行权限给 Gradle Wrapper 脚本
    - name: Build with Gradle Wrapper
      run: ./gradlew build

    # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
    # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version.
    #
    # - name: Setup Gradle
    #   uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
    #   with:
    #     gradle-version: '8.5'
    #
    # - name: Build with Gradle 8.5
    #   run: gradle build

  dependency-submission:

    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
    - uses: actions/checkout@v4
    - name: Set up JDK 17
      uses: actions/setup-java@v4
      with:
        java-version: '17'
        distribution: 'temurin'

    # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
    # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
    - name: Generate and submit dependency graph
      uses: gradle/actions/dependency-submission@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

打包发布

首先需要我们修改项目的build.gradle配置,以便发布到对应的git仓库中:

publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/shiker1996/enc-encrypt")
            credentials {
                username = System.getenv("GITHUB_ACTOR")
                password = System.getenv("GITHUB_TOKEN")
            }
        }
    }

    publications {
        gpr(MavenPublication) {
            from(components.java)
        }
    }
}

打包发布时我们可以选择publish java package with gradle,然后修改配置文件,配置我们所需的环境变量(上述中环境变量为GITHUB_ACTOR和GITHUB_TOKEN):

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will build a package using Gradle and then publish it to GitHub packages when a release is created
# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#Publishing-using-gradle

name: Gradle Package

on:
  release:
    types: [created]

jobs:
  build:

    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write

    steps:
    - uses: actions/checkout@v4
    - name: Set up JDK 17
      uses: actions/setup-java@v4
      with:
        java-version: '17'
        distribution: 'temurin'
        server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
        settings-path: ${{ github.workspace }} # location for the settings.xml file

    - name: Setup Gradle
      uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

    - name: Grant execute permission to Gradle wrapper
      run: chmod +x ./gradlew  # 添加执行权限给 Gradle Wrapper 脚本
    - name: Build with Gradle
      run: ./gradlew build

    # The USERNAME and TOKEN need to correspond to the credentials environment variables used in
    # the publishing section of your build.gradle
    - name: Publish to GitHub Packages
      run: ./gradlew publish
      env:
        GITHUB_ACTOR: ${{ github.actor }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
0

评论区