记一次 Git & GitHub 实操

记一次 Git & GitHub 实操

1、前言

之前写了一个名为 typora-tools 的小工具，主要实现了图片瘦身、标题编号、图片同步的功能，现在想将此项目上传至 GitHub 中，并记录一下 IDEA Maven 工程通过 Git 进行版本控制，并推送至 GitHub 的一些通用操作

2、前置工作

首先将配置文件中的密码信息替换掉哈

我这里把阿里云 OSS 登录的秘钥信息进行了替换

# 是否需要进行图片清理
isNeedCleanPic=true
# 是否需要进行标题编号
isNeedTiltleAutoNo=true
# 是否需要进行图片同步
isNeedPicSyncOSS=true
# 笔记的根目录（也可以填入单个的 .md 文件）
noteRootPath=<输入你的笔记存储路径>

# 阿里云 OSS 配置信息
endPoint=<输入你的 endpoint>
bucketName=<输入你的 bucketName>
accessKeyId=<输入你的 accessKeyId>
accessKeySecret=<输入你的 accessKeySecret>
bucketDomain=<输入你的 bucketDomain>

编写 REAME.md 文件

先编写好 README.md 文件，到时候一同 push 到远程仓库中

3、配置 .gitignore

配置 .gitignore 文件

如下是需要忽略的文件（不添加至版本控制中）

于是我们在项目主页中新建 .gitignore 文件，并添加如下配置

4、初始化 Git 仓库

执行 git init 初始化本地仓库

在项目根目录下执行 git init 命令初始化 Git 仓库

5、本地版本控制

执行 add 和 commit 操作

执行 git add . 将所有文件提交至暂存区

Heygo@LAPTOP-0RRBU253 MINGW64 ~/Desktop/Codes/typora-tools (master)
$ git add .
warning: LF will be replaced by CRLF in pom.xml.
The file will have its original line endings in your working directory

执行 git commit -m '<description>' 命令将暂存区的代码提交至本地仓库

Heygo@LAPTOP-0RRBU253 MINGW64 ~/Desktop/Codes/typora-tools (master)
$ git commit -m 'Version 1.0'
[master (root-commit) 0d17c04] Version 1.0
 14 files changed, 1479 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md
 create mode 100644 pom.xml
 create mode 100644 src/main/java/com/Entity/ResultEntity.java
 create mode 100644 src/main/java/com/aliyun/api/gateway/demo/util/HttpUtils.java
 create mode 100644 src/main/java/com/heygo/typora/config/OSSConfig.java
 create mode 100644 src/main/java/com/heygo/typora/config/TyporaToolConfig.java
 create mode 100644 src/main/java/com/heygo/typora/main/TyporaTools.java
 create mode 100644 src/main/java/com/heygo/typora/util/OSSUtil.java
 create mode 100644 src/main/java/com/heygo/typora/util/TyporaFileRwUtil.java
 create mode 100644 src/main/java/com/heygo/typora/util/TyporaOSSPicSyncUtil.java
 create mode 100644 src/main/java/com/heygo/typora/util/TyporaPicCleanUtil.java
 create mode 100644 src/main/java/com/heygo/typora/util/TyporaTiltleAutoNoUtil.java
 create mode 100644 src/main/resources/typora-tool.properties

6、远程版本控制

新建 GitHub 远程仓库

推送本地代码至远程仓库

执行 git push 命令将本地项目推送至远程仓库的 master 分支，注意第一次推送需要指定远程仓库的 URL 地址和分支名

Heygo@LAPTOP-0RRBU253 MINGW64 ~/Desktop/Codes/typora-tools (master)
$ git push https://github.com/oneby1314/typora-tools.git master
Enumerating objects: 32, done.
Counting objects: 100% (32/32), done.
Delta compression using up to 8 threads
Compressing objects: 100% (21/21), done.
Writing objects: 100% (32/32), 15.71 KiB | 2.24 MiB/s, done.
Total 32 (delta 1), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (1/1), done.
To https://github.com/oneby1314/typora-tools.git
 * [new branch]      master -> master

哇哦，搞定，打完收工