Skip to content

tofunology/web_workspace_old

Repository files navigation

♦注意!♦

環境構築が重要です!

まだ環境構築をしていない人は,下の方にある「環境セットアップの下拵え」から順に環境構築をしましょう.
環境構築は以下を参考にどうぞ.



♣基本的な作業手順

以下の手順を作業毎にやりましょう.

  1. masterへ移動して,最新の情報を取得
  2. 作業ブランチを作って作業ブランチへ移動
  3. 作業
  4. ローカルの変更/追加をリモートに反映
  5. masterへ戻る
  6. プルリクを出す
  7. ぎてふへ報告

1. masterへ移動して,最新の情報を取得

1-A. 情報を更新

git pull
git fetch origin master

1-B. 各ファイルを最新の情報にリセット

git reset --hard origin/master

2. 作業ブランチを作って作業ブランチへ移動

2-A. 作業するブランチ名の決定

英数字を使いましょう
全角を使った場合,命の保証はございません.
例えば
MFT2020の7月の作業の様子を記事に書きたいのなら,
makePost_MFT2020works7mとかいかがでしょう?
記事の修正なら
fixPost〜〜〜って感じですかね.

2-B. ブランチの作成&移動

以下のコマンドで作成と移動を一気に行います.
git checkout -b ブランチ名

3. 作業

♥ 記事の新規作成方法(ファイルパスに規則あり!)

web_workspaceディレクトリにいる状態で,以下のコマンドを打つことで記事を作ることができますが,わかりにくいですね.
hugo new ファイルパス
例をいくつか紹介します.

例:現在2112年!MFT2113の参加お知らせ記事を書きたい!

ファイルパスは必ずpostから始まります.
次に作成年度のフォルダを指定するので,post/2112
次にイベント名を指定するので,post/2112/MFT2113
最後に記事名+.mdをつけるから,post/2112/MFT2113/MFT2113_joinNotice.md

例:現在2221年!アップス縁日の参加報告記事を書きたい!

ファイルパスは必ずpostから始まります.
次に作成年度のフォルダを指定するので,post/2221
次にイベント名を指定するので,post/2221/upsEnnichi
最後に記事名+.mdをつけるから,post/2221/upsEnnichi/upsEnnichi_finished.md

♥ 記事の編集方法

普通に書いてもらって大丈夫です.
「記事の確認方法」を参考に,記事を書いたら絶対に確認してください.

書き方の参考

content/post/example/hoge.mdを見てください.
ビルト後のレイアウトがどうなるかは,
「記事の確認方法」を参考にサーバーを起動したら,
http://localhost:1313/site/tmp/formatdemo/で確認してください.

♥ 記事の確認方法

hugo server -D -wでサーバーを起動できます.
その後にhttp://localhost:1313/site/にアクセスしてみましょう.

4. ローカルの変更/追加をリモートに反映

4-A. 作成/変更したファイルを全てadd

git add 作成/変更したファイル名
全て追加したい場合は,web_workspaceへ移動して以下のコマンドを実行.
git add *

4-B. addした記録をローカルに保存します.

git commit -m "好きなコメント"

4-C. ローカルのcommitをリモートに反映

git push

5. masterへ戻る

以下のコマンドで戻りましょう. git checkout master

6. プルリクを出す

プルリク=PullRequest

6-A. サイトにアクセス

https://github.com/Tofunology/web_workspace/pullsへアクセス.

6-B. プルリクを作る

New Pull Requestをクリック

6-C. masterへプルリク

上部でmaster←作業ブランチ名となるようにして, Create Pull Requestをクリック

7. ぎてふへ報告

ぎてふへ「プルリクした」と連絡してください.
確認して,mergeするか修正を依頼するか判断します



もしtokenが必要と言われたら

次のリンクを参考に,入手して,ローカルに保存してください.
https://docs.github.com/ja/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

もしpushできなかったら

git pullしてからもう一度




◆ 環境セットアップの下拵え

windowsの場合

 WSLの環境とVScodeの環境を整えましょう.
 - 参考リンク:https://qiita.com/matarillo/items/61a9ead4bfe2868a0b86
 VScodeの環境を整えよう(関係ない部分はスキップ)
 - 参考リンク:https://tenshoku-miti.com/takeshi/windows10-vscode-ternimal-ubuntu/

macの場合

 homebrewを使えるようにしましょう.brewコマンドが使えれば問題ないです.基本的にはXcodeをインストールした後ならbrewを標準で使えると思います.

◆ HUGOのインストール

windows/linux系の場合

 sudo apt update
 sudo apt upgrade
 sudo apt-get install hugo

macの場合

 brew update
 brew upgrade
 brew install hugo

◆ gitのインストール

windows/linux系の場合

 sudo apt-get install git

macの場合

 brew install git

◆ githubに登録しよう

https://github.co.jp/ よりアカウントを作成してください.
登録後,メールアドレスとユーザ名をぎてふに教えてください. メールアドレスにinvitationが届くので,必ず承認してください.(承認後でないとログインできません)

◆ gitのアカウント設定

自分のパソコンのターミナルでもgitのアカウントが使えるように設定しましょう.

git config --global user.name "ユーザー名"
git config --global user.email メールアドレス

◆ パスワードを設定

最近アクセストークンによる承認に変わりました...

  1. まずアクセストークンを取得しましょう. https://techback.info/github-password-authentication-to-token/

今後もしパスワードを聞かれたら,

  1. 先ほどの作業で取得したトークンを入力
  2. 入力後,次のURLを参考にパスワード聞かれないように設定 https://qiita.com/aqua_ix/items/0433f85330087c62bffa
    1. 本当は良くないよ!

◆ 作業用リポジトリの作成

  1. 作業をするフォルダでVScodeを開きましょう
  2. git clone https://github.com/Tofunology/web_workspace.gitする

◆ これで完了です!

作業時はクローンしたフォルダをVscodeで開いて作業しましょう.また,作業前にぎてふに作業をしていいか確認を取りましょう.



About

I will be a robot.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors